xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse 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
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/Branch — entity reference
REFERENCE · Last reviewed

Branch — entity reference

An operating location of a company - the physical site documents and stock are keyed to. Every branch belongs to an owning company via partnerAccountId, and document handlers validate that a document's BranchId actually belongs to its PartnerAccountId before saving, so mismatched pairs are rejected. Inventory is bucketed per partner+branch (InventoryStock, InventoryLedger and ItemLot all carry BranchId), transfers move stock between branches (Transfer.branchId is the source - its navigation is named FromBranch - and toBranchId the destination), and StorageLocation rows subdivide a branch into zones, bins and vans. parentLocationBranchId builds a branch hierarchy, and geoLocation is a true geographic point anchoring the mobile attendance check-in geofence.

Fields

FieldLabelTypeRequiredWhat it does
AllowInventoryAllow InventoryBoolean
AllowPurchaseAllow PurchaseBoolean
AllowSalesAllow SalesBoolean
AllowServiceAllow ServiceBoolean
BranchCodeCodeText, uniqueYes
BranchTypeBranch TypePickListYesValues: Sales Branch, Service Branch.
BusinessHoursIdBusiness HoursLookup → BusinessHours
BusinessUnitIdBusiness UnitLookup → BusinessUnit
ContactAddressIdAddressLookup → ContactAddress
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DefaultInventoryValuationMethodDefault Inventory Valuation MethodPickList
DocumentNameCodeDocument Name CodeText
EmailE-mailText, unique
ExternalIdExternalText, unique
GeoLocationGeo LocationGeoLocationA true geographic point (WGS 84) serialized as latitude/longitude, replacing an older free-text value; it anchors the mobile attendance check-in geofence for the branch.
GSTINGSTINCalculated (calculated)
GSTRegistrationIdGST RegistrationLookup → GSTRegistration
IdIdTextYes
InventoryValidationMethodInventory Valation MethodPickList
IsActiveActiveBoolean
IsHomeDeliveryAvailableHome DeliveryBoolean
IsServicePickupDropAvailableService Pickup DropBoolean
MarketingNameMarketing NameText
MobileNumberMobileNumber
ModifiedByIdModified ByLookup → UserAccountYes
NameNameText
OwnerIdOwnerLookup → UserAccountYes
ParentLocationBranchIdParent LocationLookup → BranchParent branch in the branch hierarchy - a self-reference for modelling regions or hub-and-spoke structures.
PartnerAccountIdPartner AccountLookup → AccountThe company that owns the branch. Document handlers validate that a document's branch belongs to its partner account, so mismatched partner/branch pairs are rejected at save.
PayrollBusinessHoursIdPayroll Business HoursLookup → BusinessHours
PhonePhoneLargeNumber
RecordTypeIdRecord TypeGuid, hidden
SalesEmailSales EmailText
SalesPhoneSales PhoneLargeNumber
ServiceEmailService EmailText
ServicePhoneService PhoneLargeNumber
SourceOfSupplySource of SupplyPickListValues: Maharashtra, Gujarat, Rajasthan, Haryana.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
WebsiteWebsiteText

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Clone
DeleteDeleteDeleteDelete
DeleteEntityDeleteDeleteDeleteEntity
DeleteInListDeleteDeleteDelete in a list page
EditEntityEditEditEditEntity
EditInLineEditEditInlineEdit In Page
EditListHeaderEditEditInlineEditListHeader
EditListRowEditEditEditListRow
NewNewNewNew

Validations

ValidationApplies toError messageNotes
Phone Number ValidationSalesPhone, ErrorPhone number provided is not in a valid format.Check if the Mobile number is in valid format
← Book Valuation Adjustment Branch Postal Code →