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

Field Sales — entity reference

A van-sales run: one record per van journey, tying the van, the depot it loads from and the executive who drives it to a visit plan and a set of Field Sales Lines. The run's record page offers Create Visit Plan, Release Load and Unload; the executive's take-in is confirmed on the mobile Van Run card. Each step builds an inventory transfer from the line quantities (depot to van on release, onto the van on take-in, van to depot on unload) and moves the run's Status from Draft through Released and TakenIn to Reconciled. The transfers, not this record, move the stock. Runs are created by hand or by Build Van Loads, which packs open customer orders into the branch's vans.

Fields

FieldLabelTypeRequiredWhat it does
AccountGroupIdAccount GroupLookupShown on the standard create form and record Details, but not stored: a value picked here is discarded when the run is saved. The outlets a run covers come from the visits on its visit plan.
BranchIdBranchLookupThe branch the run belongs to. Every transfer the run creates is raised in this branch, for both the source and the destination leg. Build Van Loads fills it with the branch it is building for.
CashDiscrepancyReasonCash Discrepancy ReasonTextFree text explaining any difference between Cash Expected and Cash Received at day end. Up to 400 characters. Not on the standard forms; nothing checks or requires it.
CashExpectedCash ExpectedCurrencyThe money the executive should hand in: the total settled against the invoices linked to the run as Field Sales Invoice records (each invoice's Adjusted Amount, the payments applied to it). Filled only by the day-end roll-up that runs when Perform Unload is saved as on, and replaced by it each time. Shown as Cash to hand in on the mobile Van Run card.
CashReceivedCash ReceivedCurrencyThe cash the dispatcher actually took from the executive at day end, typed by hand. xMatix stores it beside Cash Expected but does not compare the two or flag a shortfall. Not on the standard forms.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DocumentDateDocument DateDateThe day of the run. The load, take-in and unload transfers are dated with it, and Create Visit Plan makes a one-day visit plan for this date. Build Van Loads sets it to the delivery date it built for.
ExecutiveResourceIdExecutive ResourceExternalIdThe sales executive who drives the van and sells on route. Create Visit Plan assigns the new plan to this person, and delivery orders created at load release name them as the deliverer. Build Van Loads fills it with the current holder of the seat that runs the van, or the van's default resource; it is not on the standard forms, so hand-built runs need it added.
IdIdGuidYes
IsLoadReleasedIs Load ReleasedBooleanYesSet to Yes once Release Load has run, even if no line had anything to load. While it is Yes, Release Load is refused with The load has already been released.
IsPlanReleasedIs Plan ReleasedBooleanYesSet to Yes once Create Visit Plan has run. Create Visit Plan is refused when this is Yes or when the run already has a Visit Plan.
IsUnloadReleasedIs Unload ReleasedBooleanYesSet to Yes once Unload has run. It does not block a second Unload; only a Reconciled status does.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextYesThe run's document number, given automatically from the Field Sales document name setting (series FS) when the run is first saved, including runs built by Build Van Loads. The transfers the run creates take their own numbers from the Transfer series and link back to the run through their Field Sales field.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountThe company the run is recorded for. It is copied onto the run's transfers, onto the visit plan Create Visit Plan makes and, as a fallback, onto delivery orders created at load release.
PerformLoadPerform LoadBooleanYesThe take-in trigger behind the Take In action. Saving it as on lands each line's Received Quantity on the van with an inward transfer (carrying the take-in damage, shortage and excess), sets Status to TakenIn and switches itself off again. It does nothing on a run already in TakenIn, for example after a single-step release. The mobile Van Run card sets it when the executive confirms the take-in.
PerformReleaseLoadPerform Release LoadBooleanYesThe trigger behind the Release Load action. Saving it as on moves each line's Quantity out of the depot with an outward transfer, sets Status to Released (or straight to TakenIn with single-step loading), sets Is Load Released and switches itself off again. With the van capacity check in Block mode an overload refuses the whole save.
PerformReleaseUnloadPerform Release UnloadBooleanYesThe trigger behind the Unload action. Saving it as on returns each line's Check-In Received Quantity, or the calculated remainder, to the depot with an inward transfer, sets Status to Reconciled and stamps Reconciled At when anything was returned, sets Is Unload Released and switches itself off again. Refused on a run that is already Reconciled.
PerformReleaseVisitPlanPerform Release Visit PlanBooleanYesThe trigger behind the Create Visit Plan action. Saving it as on creates a one-day visit plan of type Van Sales, status Planned, named Van run plus the run number and date, assigned to the Executive Resource, and links it in Visit Plan. Then it switches itself off and sets Is Plan Released.
PerformUnloadPerform UnloadBooleanYesThe trigger for the day-end roll-up. Saving it as on writes Sold Quantity onto each line from the linked invoices' lines (matched on item, SKU and lot) and totals Cash Expected. Unlike the other triggers it is not switched off afterwards, so the roll-up runs again on every later save of the run. No standard screen sets it: the preview panel shows it read-only.
ReconciledDateTimeReconciled AtDateAndTimeWhen the run was reconciled: stamped by Unload when it returns stock to the depot.
RecordTypeIdRecord TypeGuid, hidden
ResourceIdResourceLookupShown on the standard create form, record Details and page header, but not stored: a value picked here is discarded when the run is saved. The executive who drives the van is Executive Resource.
SourceStorageLocationIdSource Storage LocationExternalIdThe depot the load comes from: the source of the release transfer and the destination of the unload transfer. Build Van Loads uses the depot chosen for the build or, failing that, the branch's first non-mobile location that holds inventory, in fulfilment sequence order. Not on the standard forms, so hand-built runs need it added.
StatusStatusPickListWhere the run is in the day. xMatix writes Released when the load is released, TakenIn when the stock is on the van and Reconciled after Unload; runs built by Build Van Loads start as Draft. A run created by hand has no status until its load is released, and the mobile card treats that as Draft. The seeded option list (Draft, Loaded, Unloaded) does not match these values, so filter on the written values instead. Values: Loaded, Unloaded, Draft.
StorageLocationIdStorage LocationLookupThe van: a storage location marked Mobile. It receives the load and is the source of the unload. Its weight and volume capacity are what the van capacity check measures the planned load against. Not on the standard forms, so hand-built runs need it added.
TakenInDateTimeTaken In AtDateAndTimeWhen the stock landed on the van: stamped by a single-step load release or by the executive's take-in.
TypeTypePickListShown on the standard create form and record Details with the options Van Delivery, Ready Stock Sales and Pre-Bill, but not stored: the choice is discarded when the run is saved and has no effect. Values: Van Delivery, Ready Stock Sales, Pre-Bill.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
VisitPlanIdVisit PlanLookupThe visit plan of type Van Sales that carries the run's outlet visits; on the mobile app it is the plan that shows the Van Run card. Filled by Create Visit Plan or by Build Van Loads, and shown on the record's Details tab.
VisitRouteGroupIdVisit Route GroupLookupNot stored: there is no column behind it, and it is on no standard form.
VisitTaskTemplateIdVisit Task TemplateLookupNot stored: there is no column behind it, and it is on no standard form.

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditEdit in page.
NewNewNewNew