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 Line — entity reference
REFERENCE · Last reviewed

Field Sales Line — entity reference

One item line on a Field Sales van run. A line keeps each stage of the van journey in its own quantity field rather than overwriting one figure: Quantity is the planned load, Received Quantity and the three Take-In fields are what was confirmed onto the van, Sold Quantity is the day-end total from the run's invoices, and the four Check-In fields are what came back to the depot. Releasing, taking in and unloading the run build inventory transfers from these figures; the transfers, not the line, are what move stock. Lines built by Build Van Loads also remember the customer order line they carry.

Fields

FieldLabelTypeRequiredWhat it does
AmountAmountNumberShown on the line view and list but not stored: any value typed here is discarded. The money on a van sale lives on the invoice raised during the run.
CheckInDamagedQuantityCheck-In Damaged QuantityDecimalDamage found when the stock came back off the van at day end. Unload copies it onto the return transfer line as its damaged quantity. Separate from the take-in damage found on the way out. Not on the standard line form.
CheckInExcessQuantityCheck-In Excess QuantityDecimalExcess found in the day-end count. Unload copies it onto the return transfer line as its excess quantity. Not on the standard line form.
CheckInReceivedQuantityCheck-In Received QuantityDecimalWhat the dispatcher counted back into the depot at day end. When it is greater than zero, Unload returns exactly this quantity to the depot. When it is empty or zero, Unload returns the calculated remainder instead: received (or planned) quantity minus Sold Quantity minus Damaged Quantity, never below zero. Not on the standard line form.
CheckInShortageQuantityCheck-In Shortage QuantityDecimalShortage found in the day-end count. Unload copies it onto the return transfer line as its shortage quantity. Not on the standard line form.
ConversionRatioConversion RatioNumberHow many base units one unit of UOM holds. It is copied from the item's unit of measure when the line is saved, not typed in. Not on the standard line form.
ConversionRatio1Conversion Ratio 1NumberHow many base units one unit of UOM1 holds, copied from the item's unit of measure when the line is saved. Not on the standard line form.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DamagedQuantityDamaged QuantityNumberA general damage figure, separate from the take-in and check-in damage fields. It is not copied onto any transfer line, but Unload subtracts it when it has to calculate the return quantity because no Check-In Received Quantity was recorded.
ExcessQuantityExcess QuantityCalculatedShown on the line form and list but not stored. Record excess in Take-In Excess Quantity or Check-In Excess Quantity instead.
ExpectedReceivedQuantityExpected Received QuantityCalculatedDefined in metadata but not stored, and not shown on any standard form.
FieldSalesIdField SalesLookupYesThe Field Sales van run this line belongs to. Every line must have one: saving a line whose run cannot be found fails with Field Sales document not found.
IdIdGuidYes
ItemIdItemLookupThe item being loaded. A line without an item is skipped when transfers are built.
ItemLotIdItem LotLookupThe batch or serial lot being loaded, for lot-tracked items. When a line has a lot, saving it creates (or updates) a copy of that lot assigned to the run's branch, partner and van, so the lot can be traced on the van. Saving fails with Item Lot not found if the lot does not exist. Not on the standard line form.
ModifiedByIdModified ByLookup → UserAccountYes
NameLine NameTextYesThe line number, generated automatically from the Field Sales Line Name Setting (series FSL). Lines created by Build Van Loads are named after their run instead.
OwnerIdOwnerLookup → UserAccountYes
QuantityQuantityNumberThe planned load quantity in base units. Release Load moves this quantity from the depot to the van, and the van capacity check multiplies it by each item's unit weight and volume. Lines with zero or no quantity are skipped.
ReceivedQuantityReceived QuantityNumberWhat was confirmed onto the van. With single-step van loading (the default), Release Load sets it to the planned Quantity on every line, replacing anything typed earlier. With two-step loading, the rep enters it on the Van Run card and Take In moves this quantity onto the van; if it is empty or zero, the planned Quantity is used. The day-end sales roll-up never changes it.
RecordTypeIdRecord TypeGuid, hidden
ShortageQuantityShortage QuantityCalculated
SKUIdItem SKULookupThe item SKU being loaded, copied onto every transfer line. Sales are matched back to the line by item, SKU and lot together.
SoldQuantitySold QuantityNumberThe total quantity sold from the van, filled by the day-end roll-up from the invoice lines of the invoices linked to the run. Invoice lines are grouped by item, SKU and lot, and each total is written to the first load line with the same three values; a sale with a different SKU or lot reaches no line. The roll-up replaces the figure rather than adding to it.
TakeInDamagedQuantityTake-In Damaged QuantityDecimalDamage the rep found when counting the stock onto the van in the two-step flow. Take In copies it onto the van's inward transfer line as its damaged quantity. Not used by single-step loading.
TakeInExcessQuantityTake-In Excess QuantityDecimalExcess the rep found when counting the stock onto the van in the two-step flow; copied onto the inward transfer line as its excess quantity. The Van Run card requires Received + Damage + Short − Excess to equal the planned Quantity.
TakeInShortageQuantityTake-In Shortage QuantityDecimalShortage the rep found when counting the stock onto the van in the two-step flow; copied onto the inward transfer line as its shortage quantity.
UIPropsUI PropsText
UOMUOMPickListAn alternative unit of measure for the planned quantity. It must be one of the item's units of measure, or saving fails with UOM is not defined for this Item. Not on the standard line form.
UOM1UOM1PickListA second alternative unit of measure for the planned quantity, with the same rule as UOM. Not on the standard line form.
UOMQuantityUOM QuantityNumberThe planned quantity expressed in UOM. When it is filled, Quantity is worked out from it in base units (UOM Quantity × Conversion Ratio). When only Quantity is given, this field is filled back from it.
UOMQuantity1UOM Quantity 1NumberThe planned quantity expressed in UOM1. Its base-unit value (UOM Quantity 1 × Conversion Ratio 1) is added to the UOM leg when Quantity is worked out.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

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