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/Visit Task — entity reference
REFERENCE · Last reviewed

Visit Task — entity reference

The visit's record of one task, created when a representative first works an activity under a task card. Visits are not given task records in advance: the web and mobile visit screens read the visit's task template live and show each template entry as a task card. The first time an activity under an entry is started or completed, the screen creates this record for the visit and that entry, copying the entry's name, task type, sequence number and hidden flag, and then creates the activity record under it. A visit nobody worked therefore has no task records. The visit screens set the task to Started each time an activity is worked, and the server stamps Start Time when it first becomes Started. No delivered screen sets a task to Completed, so End Time and Duration normally stay empty, and progress is read from the task's activities instead. Only the resource the visit plan is assigned to can move a task into Started or Completed. Pointing the visit at a different template removes its task records and their activities.

Fields

FieldLabelTypeRequiredWhat it does
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DurationDurationCalculated (calculated)Minutes from Start Time to End Time, calculated. Empty or 0 until both times are set, which in practice means until someone completes the task by hand.
EndTimeEnd TimeTimeOnlyStamped by the server when the task's status is set to Completed. Because no delivered screen completes a task, it stays empty unless someone sets the status by hand.
IdIdGuidYes
IsHiddenIs HdenBooleanYesCopied from the template entry's Hidden flag when the record is created. The visit screens decide whether to hide a task from the entry, not from this flag, and a task that already has a record stays visible even when its entry is hidden later.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextThe record's number, filled in automatically from the Visit Task Document Name Setting (series VT), which is delivered switched on. It is not the task's title: the visit screens title the card from Task Name.
OwnerIdOwnerLookup → UserAccountYes
PlannedDurationPlanned DurationCalculated (calculated)Minutes between Planned Start Time and Planned End Time, calculated. Because nothing sets those times it is always 0; use Task Duration for the planned minutes.
PlannedEndTimePlanned End TimeTimeOnlyNot filled in by the visit screens or the server.
PlannedStartTimePlanned Start TimeTimeOnlyNot filled in by the visit screens or the server. The visit's own planned times are on the visit.
RecordTypeIdRecord TypeGuid, hidden
SequenceNumberSequence NumberNumberThe task card's position on this visit, lowest first. Copied from the template entry's Sequence Number when the record is created. The visit screens sort a started task by this value, so changing it on the record reorders that visit only.
StartTimeStart TimeTimeOnlyWhen the task was first set to Started, stamped by the server from the current time. In practice it is the moment the first activity under the task was worked.
StatusStatusPickListThe task's state. The delivered values are Planned, Started, Completed and Cancelled, but the visit screens only ever write Started, each time an activity under the task is worked. No delivered screen writes Completed or Cancelled, and the visit screens show task progress from the activities, not from this field. Setting Completed by hand stamps End Time. Values: Planned, Started, Completed, Cancelled.
TaskDurationTask DurationCalculated (calculated)The planned minutes for the task, read from the linked template entry's Task Duration (Mins). Not stored independently on the task.
TaskNameTaskNameLongMultiLineTextThe task card title on the visit, copied from the template entry's Name when the record is created. Later changes to the entry's Name do not reach this record, and the visit screens title the card from this field once the record exists.
TaskNumberTaskNumberNumberNot used. Defaults to 0 and nothing reads it.
TaskTypeTask TypePickListThe kind of task, copied from the template entry. The only delivered value is Perform Visit Activities, and no screen behaves differently by type. Values: Perform Visit Activities.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
VisitIdVisitLookup → VisitYesThe visit the task belongs to. Filled in automatically when the visit screen creates the record.
VisitTaskTemplateEntryIdVisit Task Template EntryLookup → VisitTaskTemplateEntryThe template entry this task was created from. The visit screens use it to match the record to its task card. Pointing it at another entry removes the activities already recorded under the task and creates nothing in their place; the card keeps its copied Task Name.

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteEntityDeleteDeleteDeleteEntity
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditEntityEditEditEditEntity
EditInLineEditEditInlineEdit
EditInListHeaderEditEditInlineEdit In List Header
NewNewNewNew