Service Order — entity reference

A service order is the workshop job card: one document per job taken in against a customer and, usually, an asset, with a line for every part and every unit of labour. It appears in the Service app on web and mobile. It is created directly or from a case, lead, appointment, service opportunity or service estimate, and its lines are copied from the estimate, else the opportunity, else the asset's service contract. It is numbered from document numbering (shipped series SV, separator -, date DDMMYYYY, six digits). Partner Account and Branch are locked once saved, and an asset can have only one service order that is not Delivered. Work Item lines are labour recorded on time sheets; Part lines go through fulfilment, allocation, picking and inventory posting, with a VOR purchase order for parts out of stock. Shipped business rules move Status through Draft, Work To Start, Work In Progress, Work Paused, Work Completed, Invoiced and Delivered. Invoice requires every time sheet ended and every part line allocated. There is no cancel action and no Cancelled status. Step-by-step procedures are on the Service orders page of the Service documentation.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account		The customer. Filled from the asset's owner when left empty.
`AccountName`	Account Name	Text
`AdjustedAdvanceAmount`	Adjusted Advance Amount	Currency
`AdvanceAmount`	Advance Amount	Currency
`AmountPaid`	Amount Pa	Currency
`AssetId`	Asset	Lookup → Asset		The machine or vehicle being serviced. Only one service order that is not Delivered may exist per asset. Picking the asset fills Account from the asset's owner when Account is empty.
`AssetServiceContractId`	Asset Service Contract	Lookup → AssetServiceContract
`BillingAddress`	Billing Address	Text
`BillingAddressId`	Billing Address	Lookup → ContactAddress
`BillingCity`	Billing City	PickList		Values: Mumbai, Pune, None, Chandigarh.
`BillingCityPlaceId`	Billing City Place	Lookup → Place		Values: Pune, Chandigarh, Mumbai.
`BillingCountry`	Billing Country	PickList		Values: India.
`BillingPostalCode`	Billing Postal Code	Text
`BillingRegion`	Billing Region	Text
`BillingState`	BillingState	PickList
`BillingStreet`	Billing Street	Text
`BranchId`	Branch	Lookup → Branch		The branch doing the job. Must be active and belong to the partner account; required when the partner account has branches. Locked once saved.
`CancelPendingQuantity`	Cancel Pending Quantity	Currency
`CheckInInspectionId`	Check In Inspection	Lookup → CheckInInspection		The check-in inspection created by the Check In action, recording the asset's condition at reception.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime
`CustomerVoice`	Customer Voice	Text		The customer's complaint in their own words.
`DiscountGroupId`	Discount Group	Lookup → DiscountGroup
`DocumentDate`	Document Date	Date		The order's business date. Set to today when left empty.
`ExternalId`	External	Text
`FailureDate`	Failure Date	Date
`Id`	Id	Guid
`InspectionLineId`	Inspection Line	Lookup → InspectionLine
`IsClaimed`	Is Claimed	Boolean
`IsDelivered`	Delivered	Boolean		Set by the Delivery action, which also sets Status to Delivered, releases the bay, closes the originating inspection line and records campaign maintenance against the asset.
`IsILPosted`	IL Posted	Boolean
`IsInJobQueue`	In Job Queue	Boolean
`IsInvoiceGenerated`	Invoice Generated	Boolean		Set when the Invoice or Selective Invoice action raises documents. Drives the Invoiced status.
`IsKPICalculated`	KPI Calculated	Boolean
`IsLinePopulated`	Line Populated	Boolean
`IsQuoteGenerated`	Quote Generated	Boolean		Guard flag for the Generate Quote action rather than a status: once true, that action refuses to run again for the order.
`IsReleasedForFulfillment`	Released For Fulfillment	Boolean		Protected system flag that the handler refuses to let a client set or change; releasing parts is done through the release-for-fulfilment action, not by writing this field.
`IsTimeSheetGenerated`	Is Time Sheet Generated	Boolean
`IsWorkEnded`	Work Ended	Boolean
`IsWorkPaused`	Is Work Paused	Boolean
`IsWorkStarted`	Work Started	Boolean		Raised to true when work begins, either directly or by a time sheet whose lines have all been started. Time sheets only ever raise this flag and never clear it, so it stays true once set even if work is later paused or the sheet is reworked.
`ItemId`	Item	Lookup → Item
`ItemLotId`	Item Lot	Lookup → ItemLot
`ItemServiceContractId`	Service Contract	Lookup → ItemServiceContract		The service contract covering the work. Requires an active asset service contract on the asset where the contract needs one. On a new order with no estimate and no lines, its pending entitlements are added as lines. It can be changed only while no time sheet has started work and no part has been allocated.
`JobQueueId`	Job Queue	Lookup
`ModifiedById`	Modified By	Lookup → UserAccount
`Name`	Document Number	Text		The service order's document number, generated on save from the Service Order Name Setting. The shipped format is SV, a hyphen, the document date as DDMMYYYY, a hyphen and a six-digit counter that restarts each day.
`OpenAdvanceAmount`	Open Advance Amount	Calculated (calculated)		Calculated as the advance received less the advance already adjusted against billing — the unapplied balance of the customer's deposit.
`OpenAmount`	Open Amount	Calculated (calculated)		Calculated as the total amount less the advance taken, i.e. what would still be collectable if the job were billed in full today. It is not driven by invoices actually raised.
`OpportunityId`	Opportunity	Lookup → Opportunity		The service opportunity or booking this job came from. Setting or changing it populates the order's lines from the opportunity lines, but only when no service estimate quote is set on the order; on create the new order's id is also stamped back onto the opportunity.
`OrderAmount`	Order Amount	Currency
`OutstandingAmount`	Outstanding Amount	Calculated (calculated)		Calculated as total tax plus the order amount less the amount paid. Note that it is built on OrderAmount rather than on the calculated TotalAmount, so the two headline balances on the document are derived from different bases.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PackageServiceId`	Package Service	Lookup → Item
`PartnerAccountId`	Partner Account	Lookup → Account		Your operating company for the job. Must be active. Locked once saved.
`PendingFulfilmentAllocationQuantity`	Pending Allocation Quantity	Calculated (calculated)
`PendingInvoiceQuantity`	Pending Invoice Quantity	Calculated (calculated)
`PendingPickingQuantity`	Pending Picking Quantity	Calculated (calculated)
`PerformGenerateQuote`	Perform Generate Quote	Boolean
`PerformInventoryPosting`	Perform Inventory Posting	Boolean
`PerformInvoiceGeneration`	Perform Invoice Generation	Boolean		Legacy trigger checkbox from the era when saving the record with the box ticked ran the step.
`PerformKPICalculation`	Perform KPI Calculation	Boolean
`PerformPopulateChecklist`	Perform Populate Checklist	Boolean
`PerformPopulateLines`	Perform Populate Lines	Boolean
`PerformReleaseForFulfillment`	Perform Release For Fulfillment	Boolean
`PerformWorkEnd`	Perform Work End	Boolean
`PerformWorkStart`	Perform Work Start	Boolean
`PopulateAssetMaintenance`	Populate Asset Maintenance	Boolean		Unlike the other Perform/Populate checkboxes this one is live: switching it on an existing order makes the handler pull the due asset-maintenance items for the order's Asset (from opportunities flagged for maintenance) in as new service order lines, skipping any maintenance item already present on the order.
`PriceAsOnDate`	Price As On Date	Date		The date used to look up prices. Changing it reprices every line.
`PriceListId`	Price List	Lookup → PriceList
`QuoteForItemServiceContractId`	Quote For Service Contract	Lookup → ItemServiceContract		Selects which item service contract the Generate Quote action should quote for: only service order lines whose own item service contract matches this value become quote lines, and the action is refused when none match.
`QuoteId`	Quote	Lookup → Quote
`RecordTypeId`	Record Type	Guid, hidden
`Remarks`	Remarks	Text
`ResetUsageHours`	Reset Usage Hours	Boolean
`ResetUsageReading`	Reset Usage Reading	Boolean
`ResourceId`	Executive	Lookup → Resource		The service advisor on the create form. Must be authorized for the order's partner account and branch. Used as the time sheet technician when no technician is given.
`RNAExternalId`	RNA External	Text
`RoundOff`	Round Off	Currency
`ServiceAdvisorId`	Executive	Lookup → Resource		The service advisor shown on the record's details. Must be authorized for the order's partner account and branch.
`ServiceContractItemId`	Service Contract Item	Lookup → ServiceContractItem
`ServiceEstimateQuoteId`	Service Estimate	Lookup → Quote		The service-estimate Quote this job was approved from. Setting it on create, or changing it later, copies that quote's lines onto the order (item, quantity, prices, durations, contract and posting type, discounts) and takes precedence over the opportunity and contract line sources — lines are only copied when the order has none yet.
`ServiceType`	Service Type	PickList		The kind of job: Paid Repairs, Free Service, Warranty Service, Dealer Expense or PDI. The shipped create form offers the first four. Values: Paid Repairs, Free Service, Warranty Service, Dealer Expense.
`ShippingAddress`	Shipping Address	Text
`ShippingAddressId`	Shipping Address	Lookup → ContactAddress
`ShippingCity`	Shipping City	PickList		Values: Pune, Mumbai, Chandigarh.
`ShippingCityPlaceId`	Shipping City	Lookup → Place		Values: Mumbai, Pune, Chandigarh.
`ShippingCountry`	Shipping Country	PickList		Values: India.
`ShippingPostalCode`	Shipping Postal Code	Text
`ShippingRegion`	Shipping Region	Text
`ShippingState`	Shipping State	PickList		Values: Haryana, Maharashtra, New Delhi, Punjab.
`ShippingStreet`	Shipping Street	Text
`SkipScheme`	Skip Scheme	Boolean		When on, trade-scheme evaluation is skipped for the whole order.
`SplitInvoices`	Split Invoices	Boolean		Stored but not used by the platform. Invoices are split by each line's Invoice Group.
`StandardDuration`	Standard Duration	Currency
`Status`	Status	PickList		The job's stage: Draft (the default), Work To Start, Work In Progress, Work Paused, Work Completed, Invoiced or Delivered. Shipped business rules set it from the progress flags: a time sheet created, work started, paused or ended, parts fully allocated, invoice generated, delivered. Work Completed is refused while any non-cancelled Work Item line has not ended, and no status change is allowed while a work order for subcontracted lines is still open. Values: Draft, Work To Start, Work In Progress, Work Paused, Work Completed, Invoiced, Delivered.
`SupplierAccountId`	Supplier Account	Lookup → Account		The default supplier for VOR purchase orders, used when the VOR action is not given a supplier.
`Tax1`	Tax1	Currency
`Tax1Name`	TaxName1	Text
`Tax1Rate`	TaxRate1	Currency
`Tax1Type`	TaxType1	Text
`TaxGroupId`	Tax Group	Lookup → TaxGroup
`TaxId`	Tax	Lookup → Tax
`TaxSupplyType`	Tax Supply Type	PickList		Values: Within State, Outside State.
`TCSEligibleAmount`	TCS Eligible Amount	Currency
`TechnicianId`	Executive	Lookup → Resource		The default technician for time sheets created from the order.
`TotalAmount`	Total Amount	Calculated (calculated)		Calculated header total: the line total plus tax, where tax is TotalTax when it is positive and otherwise the derived TotalTaxAmount2. It is the figure OpenAmount is measured against.
`TotalDiscountAmount`	Total Discount Amount	Calculated (calculated)
`TotalLabourAmount`	Total Labour Amount	Calculated (calculated)
`TotalLineAmount`	Total Line Amount	Calculated (calculated)
`TotalLineBaseAmount`	Total Line Base Amount	Calculated (calculated)
`TotalLineGrossAmount`	Total Line Gross Amount	Calculated (calculated)
`TotalLineTaxAmount`	Total Line Tax Amount	Calculated (calculated)		Header roll-up of tax from the lines. Its seeded calculated formula is self-referential (it adds Tax1 to its own current value), so treat this figure with suspicion and prefer summing the lines' TaxAmount when accuracy matters.
`TotalPackageItemsAmount`	Total Package Items Amount	Calculated (calculated)
`TotalPartAmount`	Total Part Amount	Currency
`TotalSchemeDiscountAmount`	Total Scheme Discount Amount	Currency
`TotalTax`	Total Tax Amount	Currency
`TotalTaxAmount2`	Total Tax Amount	Calculated (calculated)		Calculated fallback tax total — the lines' tax total plus the header-level Tax1 — used by TotalAmount whenever TotalTax is zero or negative.
`TransactionType`	Transaction Type	PickList
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime
`UsageReading`	Usage Reading	Decimal		The asset's meter reading at reception. Cannot be lower than the asset's last recorded reading and, when a service contract is set, must fall inside the contract's usage band. Written to the asset when the order is invoiced.
`UsageReadingHours`	Usage Reading (Hours)	Decimal		The asset's hour-meter reading at reception, validated like Usage Reading.
`WorkCompletedBy`	Work Completed By	Lookup
`WorkStartedAt`	Work Started At	DateAndTime		Timestamp of when work began on the job at header level. The per-line and per-time-sheet stamps are separate fields, and this header value is not derived from them.

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete
`CancelAllocation`	Cancel Allocation	ServerAction (`CancelAllocation`)	CancelAllocation
`CancelPicking`	Cancel Picking	ServerAction (`CancelPicking`)	CancelPicking
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`CreateTimeSheet`	Create Time Sheet	ServerAction (`CreateTimeSheet`)	Creates one ServiceOrderTimeSheet for the order plus a sheet line for every selected service order line whose Item is a Work Item — part lines are dropped even if selected. It copies the order's ResourceId onto the sheet, seeds the work start date from the order or the payload, stamps the sheet id and work status back onto the covered service order lines, and sets IsTimeSheetGenerated on the order.
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`DeleteList`	Delete	Delete	Delete
`DeleteRow`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	Edit	Edit
`EditInLinepage`	Edit	EditInline	Edit
`EditRow`	Edit	EditInline	Edit
`EndWork`	End Work	ServerAction	End Work
`FetchTelematicsData`	Fetch Telematics Data	ServerAction (`FetchTelematicsData`)	Fetch Telematics Data
`GetSchemeRecommendations`	Get Scheme Recommendations	ServerAction (`GetSchemeRecommendations`)	Get Scheme Recommendations
`GetSchemeRecommendations`	Get Scheme Recommendations	ServerAction (`GetSchemeRecommendations`)	Get Scheme Recommendations
`GetServiceRecommendation`	Get Service Recommendation	ServerAction (`GetServiceRecommendation`)	Read-only lookup that returns the recommendations to offer the customer on this job: every open recommendation for the order's Asset — not utilised, not yet accepted or rejected, and not already attached to an order or quote — plus any already attached to this service order. It returns nothing when the order has no Asset.
`New`	New	New	New
`PauseWork`	Pause Work	ServerAction	Pause Work
`PerformAllocation`	Allocation	ServerAction (`PerformAllocation`)	PerformAllocation
`PerformGenerateQuote`	Perform Generate Quote	ServerAction (`PerformGenerateQuote`)	Creates a Quote from the order for the item service contract named in QuoteForItemServiceContractId, taking only the service order lines whose own item service contract matches it. It is refused when a quote has already been generated for the order or when no line qualifies, so it is a one-shot per order rather than a re-runnable estimate.
`PerformInvoiceGeneration`	Invoice	ServerAction (`PerformInvoiceGeneration`)	Does far more than raise an invoice. For every line with pending invoice quantity it creates customer invoice documents in Draft (split per invoice group and per item service contract, with lines matched to allocation lines where the parts were allocated), then creates warranty claims for the claimable lines, marks any service recommendations consumed by the order as utilised, updates the asset and its maintenance history, and finally sets IsInvoiceGenerated on the order. Lines classified as Packaged Item are excluded, and the action is refused when no line has pending invoice quantity.
`PerformMarkDelivered`	Mark Delivered	ServerAction (`PerformMarkDelivered`)	PerformMarkDelivered
`PerformPicking`	Picking	ServerAction (`PerformPicking`)	PerformPicking
`PerformPopulateChecklist`	Populate Checklist	ServerAction (`PerformPopulateChecklist`)	Fills in the check-in inspection checklist detail for the order from the configured checklist template. It runs with no precondition checks, and because saving checklist lines is what fires the service recommendation rules, this is the step that produces the order's recommendations.
`PerformVehicleOffroad`	VOR PO	ServerAction (`PerformVehicleOffroad`)	Creates one Purchase Order against the order's supplier and branch for parts the workshop does not have, so a stranded job can be ordered out. It considers only lines whose Item is of type Part, that have a quantity and no purchase order line yet, and it skips any part that already shows available stock for the order's branch and partner; each resulting purchase order line is linked back to the service order line it came from.
`PostServiceRecommendation`	Post Service Recommendation	ServerAction (`PostServiceRecommendation`)	Applies the customer's accept/reject decisions from the payload to the named recommendations, then, for each newly accepted one that is not yet attached to a line, creates a service order line for its Item and links the two. Quantity on the new line is taken from the recommendation's NumericValue (falling back to 1), not from its Quantity field, so a numeric inspection reading becomes the ordered quantity.
`ProductCatalogue`	Product Catalogue	ServerAction, inactive	Product Catalogue
`SelectiveAllocation`	Selective Allocation	ServerAction (`SelectiveAllocation`), inactive	SelectiveAllocation
`SelectiveCancelAllocation`	Selective Cancel Allocation	ServerAction (`SelectiveCancelAllocation`), inactive	SelectiveCancelAllocation
`SelectiveFulfilment`	Selective Fulfilment	ServerAction (`SelectiveFulfilment`)	The same fulfilment raise as the full release, but restricted to the service order lines supplied in the action payload, each with an optional requested quantity that is validated against — and cannot exceed — that line's pending fulfilment quantity. Omitting the quantity falls back to the line's full pending amount.
`SelectiveInvoice`	Selective Invoice	ServerAction (`SelectiveInvoice`)	Runs the same invoice-plus-claim-plus-asset-update chain as the full invoice generation, but only for the service order lines named in the payload; a requested quantity is capped at that line's pending invoice quantity and, when omitted, defaults to the whole pending amount.
`SelectivePicking`	Selective Picking	ServerAction (`SelectivePicking`)	SelectivePicking
`StartWork`	Start Work	ServerAction	Start Work

Validations

Validation	Applies to	Error message	Notes
Usage Reading blank	Error	Usage Reading can not be blank	Usage Reading can not be blank
Usage Reading Validation Rule	`UsageReading`, Error	Usage Reading Cannot be Negative	Usage Reading Cannot be Negative

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`
Customer Account Filter	`AccountId`
Executive Filter	`ResourceId`	Executive
Partner Account Filter	`PartnerAccountId`

InspectionLine — looks up via InspectionLineId
TaxGroup — looks up via TaxGroupId
ContactAddress — looks up via BillingAddressId
AssetServiceContract — looks up via AssetServiceContractId
UserAccount — looks up via OwnerId
Item — looks up via ServiceContractItemId
UserAccount — looks up via CreatedById
ItemServiceContract — looks up via ItemServiceContractId
Branch — looks up via BranchId
CheckInInspection — looks up via CheckInInspectionId
Account — looks up via AccountId
Resource — looks up via ResourceId
ItemServiceContract — looks up via QuoteForItemServiceContractId
Item — looks up via PackageServiceId
UserAccount — looks up via ModifiedById
Place — looks up via BillingCityPlaceId
Place — looks up via ShippingCityPlaceId
PriceList — looks up via PriceListId
Asset — looks up via AssetId
Tax — looks up via TaxId
ContactAddress — looks up via ShippingAddressId
Resource — looks up via ServiceAdvisorId
Opportunity — looks up via OpportunityId
ItemLot — looks up via ItemLotId
Quote — looks up via ServiceEstimateQuoteId
Account — looks up via SupplierAccountId
Account — looks up via PartnerAccountId
DiscountGroup — looks up via DiscountGroupId
InventoryFulfilmentPickingLine — referenced by via ServiceOrderId
AssetMaintenance — referenced by via ServiceOrderId
VisitTaskActivity — referenced by via ServiceOrderId
ServiceOrderTimeSheet — referenced by via ServiceOrderId
ClaimLine — referenced by via ServiceOrderId
Payment — referenced by via ServiceOrderId
InventoryFulfilmentAllocationLine — referenced by via ServiceOrderId
CheckInInspection — referenced by via ServiceOrderId
InventoryFulfilment — referenced by via ServiceOrderId
ComplaintFault — referenced by via ServiceOrderId
Opportunity — referenced by via ServiceOrderId
ProductDemo — referenced by via ServiceOrderId
Visit — referenced by via ServiceOrderId
Invoice — referenced by via RepairOrderServiceOrderId
Claim — referenced by via ServiceOrderId
PurchaseOrder — referenced by via ServiceOrderId
DeliveryOrder — referenced by via ServiceOrderId
Quote — referenced by via ServiceOrderId
Case — referenced by via ServiceOrderId
AssetServiceContract — referenced by via ServiceOrderId
InventoryLedger — referenced by via ParentRecordId
ServiceOrderLine — referenced by via ServiceOrderId
SchemeLedger — referenced by via ServiceOrderId

Service Order — entity reference

Fields

Actions

Validations

Lookup filters

Related entities

Related topics