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

Branch — entity reference

A branch is one operating location of a company, such as a showroom, depot, service centre or office, and the place documents, stock and people are keyed to. Every branch belongs to one company through Partner Account. When a company has at least one branch, every document for that company must name one of its active branches, and a document whose branch belongs to another company is rejected; a company with no branches cannot carry a branch on its documents. Stock is kept per company and branch, and every storage location belongs to exactly one branch. A branch can carry its own GST registration, whose GSTIN and state are copied onto the branch. A resource's Default Branch fills the branch on documents that person creates, and the branch's Geo Location is the centre of the optional mobile check-in location gate. A new organization starts with no branches; an organization with one location can hide the branch dimension everywhere with the Org Settings switch We operate from multiple locations.

Fields

FieldLabelTypeRequiredWhat it does
AllowInventoryAllow InventoryBooleanRecords that the branch holds stock. Informational: no built-in process blocks documents based on it. Companies onboarded through partner onboarding get it ticked.
AllowPurchaseAllow PurchaseBooleanRecords that the branch buys. Informational: no built-in process blocks documents based on it. Companies onboarded through partner onboarding get it ticked.
AllowSalesAllow SalesBooleanRecords that the branch sells. Informational: no built-in process blocks documents based on it. Companies onboarded through partner onboarding get it ticked.
AllowServiceAllow ServiceBooleanRecords that the branch provides service. Informational: no built-in process blocks documents based on it. Companies onboarded through partner onboarding get it ticked.
BranchCodeCodeText, uniqueYesA short identifier for the branch. Required and unique across all branches.
BranchTypeBranch TypePickListYesWhether the branch is a sales or a service location. Required. Values: Sales Branch, Service Branch. The All Sales Branches and All Service Branches views filter on it. Values: Sales Branch, Service Branch.
BusinessHoursIdBusiness HoursLookup → BusinessHoursThe branch's working week and time zone. Mobile attendance working-hours checks and time-zone handling use it for a resource who has no business hours of their own.
BusinessUnitIdBusiness UnitLookup → BusinessUnitThe business unit (finance division) the branch belongs to. When a journal posts, every line at this branch that has no business unit of its own takes this one, so it decides which division the branch's postings report under. Changing it affects only journals posted afterwards. Set on the record page with Edit; the create form does not show it.
ContactAddressIdAddressLookup → ContactAddressThe branch's postal address, a contact address record.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DefaultInventoryValuationMethodDefault Inventory Valuation MethodPickListNot used by any built-in process and has no values.
DocumentNameCodeDocument Name CodeTextA short code that, together with the company's code, forms an invoice's document series. Not part of the standard invoice numbering.
EmailE-mailText, uniqueThe branch e-mail address. Unique across branches when filled.
ExternalIdExternalText, unique
GeoLocationGeo LocationGeoLocationThe branch's position as latitude and longitude. It is the centre of the mobile check-in location gate for resources whose default branch this is; without it a check-in is allowed and the location is only recorded. Also used as the depot when van loads are planned.
GSTINGSTINCalculated (calculated)The branch's GST identification number. Read-only, derived from the GST registration.
GSTRegistrationIdGST RegistrationLookup → GSTRegistrationThe GST registration the branch trades under. Choosing or changing it copies the registration's GSTIN and state onto the branch on save and fills an empty Partner Account. Documents raised at the branch file under this registration in preference to the company's default.
IdIdTextYes
InventoryValidationMethodInventory Valation MethodPickListNot used by any built-in process and has no values.
IsActiveActiveBooleanWhether the branch can be used. A document saved with an inactive branch is rejected with Branch is Inactive. Clear it to retire a branch while keeping its history.
IsHomeDeliveryAvailableHome DeliveryBooleanRecords whether the branch offers home delivery. Informational.
IsServicePickupDropAvailableService Pickup DropBooleanRecords whether the branch offers service pickup and drop. Informational.
MarketingNameMarketing NameTextA customer-facing name for the location. Optional.
MobileNumberMobileNumberThe branch mobile number, stored as text so leading zeros are kept. Its dialling prefix is held in a separate country-code field that defaults to +91.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextThe branch's name as it appears in lookups and on documents.
OwnerIdOwnerLookup → UserAccountYes
ParentLocationBranchIdParent LocationLookup → BranchA parent branch, for recording a regional or hub-and-spoke structure. No built-in process uses the hierarchy.
PartnerAccountIdPartner AccountLookup → AccountThe company that owns the branch. Documents are rejected when their branch does not belong to their company, and document Branch pickers list only the branches of the chosen company. Filled from the GST registration when left empty.
PayrollBusinessHoursIdPayroll Business HoursLookup → BusinessHoursNot used by any built-in process; attendance and payroll use Business Hours.
PhonePhoneLargeNumber
RecordTypeIdRecord TypeGuid, hidden
SalesEmailSales EmailText
SalesPhoneSales PhoneLargeNumberThe sales desk number. When filled it must be exactly 10 digits, otherwise saving fails with Phone number provided is not in a valid format.
ServiceEmailService EmailText
ServicePhoneService PhoneLargeNumber
SourceOfSupplySource of SupplyPickListThe state the branch supplies from, set from the GST registration's state. Sales and purchase documents raised at the branch take it as their place of supply when they leave it empty. Values: 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 →