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

Account — entity reference

The platform's single party master: every organisation or person the tenant deals with - retail outlet, customer, dealer, supplier, and the tenant's own operating companies - is one row here, told apart by the IsCustomerAccount / IsSupplierAccount / IsPartnerAccount flags rather than by separate tables. Account itself has no PartnerAccountId column - its only self-references are ParentId for the org hierarchy and PartnerOwnerAccountId. Company-level settings live on the 1:1 satellite PartnerAccountProfile, and when multi-company scoping is enforced a partner Account is only authorised to be transacted against once that satellite row exists.

Fields

FieldLabelTypeRequiredWhat it does
AccountCodeCodeText, unique
AccountContactIdAccount ContactLookupThe account's primary Contact. On insert of a customer account this is populated automatically from the name, email and phone on the account itself when CreateAccountContact is set, and subsequent edits to those fields are pushed back onto that contact - so it is usually system-maintained rather than picked.
AccountLocationAccount LocationTextFree-text location note, nothing more - it is a plain string column and holds no coordinates. The account's actual geographic point lives in GeoLocation; a field of the same name on VisitRouteStop is a genuine geography point, which makes this one a frequent source of confusion.
AccountNumberAccount NumberText
AccountSourceAccount SourcePickListValues: Web, Phone Inquiry, Partner Referral, Purchase List, Other.
AnnualRevenueAnnual RevenueCurrency
ApplyPostTaxDiscountApply Post Tax DiscountBooleanSet on a partner (company) account, this is copied by the tax service onto documents raised under that company to make discounts apply after tax rather than before. It is read from the partner side of the transaction, not from the customer.
AvailableRewardPointsAvailableRewardPointsDecimalDo not quote it as a loyalty balance.
BillingAddressBilling AddressText
BillingCityBilling CityPickListFree-text billing city held independently of the BillingCityPlaceId lookup, which remains the canonical Place reference. It exists so imports and integrations can land a city name that has no matching Place row, which means the two can disagree. Values: Pune, Mumbai, Chandigarh, Delhi, Calicut, Nagpur, Coimbatore, Amritsar, Siddipet, Vaishali, Rajkot, Bathinda, Kollam, Cuttack, Puducherry, Prithvipur, Perinthalmanna, Noida, Muzaffarnagar, Ballia, Bulandshahr, Meerut, Achhalda, Agra, Haridwar, Tirupati, Mohali, Indore, Nashik, Solapur.
BillingCityPlaceIdBilling CityLookup → Place
BillingCountryBilling CountryPickListValues: India.
BillingPostalCodeBilling Postal CodeText
BillingRegionBilling RegionText
BillingStateBilling StatePickListValues: Haryana, Maharashtra, New Delhi, Punjab.
BillingStreetBilling StreetText
ClaimableAmountClaimable AmountCurrency
CreateAccountContactCreate Account ContactBooleanOpt-in switch, honoured only for customer accounts on insert: when set, the save pipeline creates the primary Contact from the account's own name/email/phone and links it as AccountContactId. It is a one-shot instruction to the create path, not a standing setting.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DeducteeTypeDeductee TypePickListThe statutory withholding classification of the party, which drives dual-rate section resolution (for example the individual/HUF rate versus the rate for other entities) and the deductee code written into withholding return files. Values: Individual, HUF, Company, Firm / LLP, AOP / BOI, Local Authority, Government, Trust.
DefaultTdsSectionIdDefault TDS SectionLookup → TdsSectionThe withholding section defaulted onto new bill and invoice lines for this party; the line's own section remains the override, so a document can legitimately differ from it.
DescriptionAccount DescriptionText
DocumentNameCodeDocument Name CodeTextA short code (up to five characters) contributed to generated document numbers: an invoice's document series is the partner account's code concatenated with the branch's code. Meaningful mainly on partner (company) accounts.
EmailEmailText
ExternalIdExternalText
FaxAccount FaxText
FirstNameFirst NameText
GeoLocationGeo LocationGeoLocationAccount coordinates (geography point, SRID 4326); powers the 'Nearby to onboard' proximity search.
GSTINGSTINLongMultiLineText
GSTRegistrationTypeGST Registration TypePickListValues: GST Registered- Regular, GST Registered- Composition, GST Unregistered, Consumer, Overseas, Special Economic Zone (SEZ), Deemed Exports, Non GST Supply, Out Of Scope.
IdIdGuidYes
IndustryIndustryPickListValues: Technology, Chemicals, Manufacturing, Construction, Retail, Banking, Electronics, Finance.
IsActiveActiveBoolean
IsCustomerAccountCustomer AccountBooleanMarks the party as a sell-to counterparty. It is a genuine gate rather than a label: customer lookups on transactional entities filter on it, the account's primary contact is auto-created only for customer accounts, and the outlet classification sweep only considers accounts carrying it. The three role flags are independent - one Account can be customer, supplier and partner at once.
IsDeadOutletDead OutletBooleanThe outlet has stopped ordering. Drives the field rep's Dead Outlets card. Set by hand, by the system of record, or by the sales.outletClassification sweep -- if that sweep is enabled it is authoritative and overwrites manual edits.
IsGLPostingEnabledGL Posting EnabledBooleanTurning this on for an existing account triggers creation of a standard chart of accounts for it during the save - it is an action disguised as a checkbox, not merely a permission flag. It only fires on update, so setting it at creation time does not seed the chart.
IsPartnerAccountPartner AccountBooleanMarks this Account as one of the tenant's own operating companies rather than a counterparty; when true the Account is the thing that owns fiscal years, branches, business units, GST registrations and the PartnerAccountId on every transactional document. The flag stays freely editable and does not by itself authorise transacting - a partner Account may exist and never trade; what authorises it is the onboarding satellite PartnerAccountProfile.
IsPlatinumOutletPlatinum OutletBooleanHigh-value outlet. Drives the field rep's Platinum Outlets card. Set by hand, by the system of record, or by the sales.outletClassification sweep -- if that sweep is enabled it is authoritative and overwrites manual edits.
IsRCMIs RCMBoolean
IsRelatedPartyRelated PartyBoolean
IsSupplierAccountSupplier AccountBooleanIndependent of the customer and partner flags.
IsTaxExemptedTax ExemptedBoolean
LabelAccount LabelText
LastNameLast NameText
ModifiedByIdModified ByLookup → UserAccountYes
MSMEEnterpriseCategoryMSME Enterprise CategoryPickListRegistered activity: Manufacturing, Service or Trading. Trading enterprises are outside the MSMED delayed-payment relief. Values: Manufacturing, Service, Trading.
MSMEEnterpriseTypeMSME Enterprise TypePickListMicro / Small / Medium classification shown on the supplier Udyam certificate. Values: Micro, Small, Medium.
MSMEPaymentDueDaysMSME Payment Due DaysNumberAgreed credit period in days for MSMED s.15 (statutory cap 45; 15 days when nothing is agreed in writing).
MSMERegistrationDateMSME Registration DateDateDate of MSME / Udyam registration as printed on the certificate.
MSMERegistrationStatusMSME Registration StatusPickListMSME registration standing declared by the supplier. Only Registered attracts the MSMED s.15 payment window and s.16 delayed-payment interest. Values: Registered, Not Registered, Declaration Awaited, Deregistered.
MSMEUdyamNumberUdyam Registration NumberTextUdyam Registration Number issued by the Udyam portal, in the format UDYAM-XX-00-0000000.
MSMEVerifiedOnMSME Verified OnDateDate the Udyam number was last verified against the Udyam portal.
NameNameText
NumberOfEmployeesEmployeesNumber
OwnerIdOwnerLookup → UserAccountYes
OwnershipOwnershipText
PANPANText
PanVerificationSourcePAN Verification SourceText
PanVerificationStatusPAN VerificationPickListResult of checking the party's PAN against the department - verified, invalid, or a name mismatch; empty means never checked. Written either by the bulk verification import or by hand. The withholding return checklist warns on unverified deductee PANs and errors on invalid ones, so this drives filing readiness. Values: Verified, Invalid, Name Mismatch.
PanVerifiedOnPAN Verified OnDateAndTime
ParentIdAccountLookup → AccountSelf-reference building the account hierarchy - subsidiaries, divisions or branch outlets hung under a head office. It is an organisational hierarchy for the counterparty, unrelated to the company-ownership link expressed by PartnerOwnerAccountId; the seeded Account Hierarchy view is built on it.
PartnerOwnerAccountIdPartner Owner AccountLookup → AccountPoints at the partner company that owns this counterparty record - the one self-reference on Account that expresses the company dimension, as distinct from ParentId which expresses the customer's own corporate hierarchy.
PhonePhoneText, unique
PhotoUrlPhoto UrlText
PlaceOfSupplyPlace of SupplyPickListValues: Maharashtra, Gujarat, Rajasthan, Haryana.
PlatinumOutletOrderCountPlatinum Outlet Order CountNumberOrder count behind the platinum classification, shown as the badge on the Platinum Outlets card. Computed over the classifier's trailing window -- read-only, because a hand-typed value would state a measurement nobody took.
RatingAccount RatingPickListValues: Hot, Warm, Cold.
RecordTypeIdRecord TypeGuid, hidden
RelatedPartyEffectiveFromRelated Party FromDate
RelatedPartyEffectiveToRelated Party ToDate
RelatedPartyRelationshipRelationshipText
RelatedPartyTypeRelated Party TypePickListValues: Director, Key Management Personnel, Relative of Director / KMP, Holding Company, Subsidiary Company, Fellow Subsidiary (Sister Concern), Associate / Joint Venture, Entity Controlled by Director / KMP, Promoter, Other.
RewardPointsReward PointsDecimalDeclared on the account master but written and read by nothing in the platform - loyalty accrual lives on the scheme ledger, not here. Any value present arrived from an import or manual entry.
SalutationSalutationPickListValues: Ms., Dr., Prof., Mx..
ShippingAddressShipping AddressText
ShippingCityShipping CityPickListValues: Mumbai, Pune, Chandigarh, Mohali.
ShippingCityPlaceIdShipping CityLookup → Place
ShippingCountryShipping CountryPickListValues: India.
ShippingPostalCodeShipping Postal CodeText
ShippingRegionShipping RegionText
ShippingStateShipping StatePickListValues: Haryana, Maharashtra, New Delhi, Punjab.
ShippingStreetShipping StreetText
SicSicText
SicDescSIC DescriptionTextThe industry classification code itself is held in Sic.
SiteAccount SiteText
StatusStatusPickListWhatever it holds was typed by a user or written by an integration, so do not treat it as evidence that an account was approved. Values: Draft, Created, Pending Approval, Approved, Rejected.
TANTANText
TdsApplicableTDS ApplicableBooleanFalse means this party is exempt from withholding at this deductor - for example a transporter that has filed the relevant declaration. Absence of a value is not the same as an exemption.
TickerSymbolTickerSymbolText
TradestyleTradestyleTextA trading-as name has to go in Label or Site.
TypeAccount TypePickListA commercial classification of the relationship (direct customer, channel customer, reseller, installation or technology partner, prospect). It is descriptive only - no engine branches on it, and it does not control the IsCustomerAccount / IsSupplierAccount / IsPartnerAccount role flags, which are what the platform actually enforces. Values: Customer - Direct.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
WebsiteWebsiteText
YearStartedYear StartedText

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Clone
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineEdit in page.
EditInListEditEditInlineEdit in List Header
EditPopupEditEditEdit
FindDuplicatesFind DuplicatesServerAction (FindDuplicates), hiddenFinds records that may be duplicates of this account via the shared record-merge engine's duplicate detection; read-only, typically run before Merge.
FindMergedMerged RecordsServerAction (FindMerged), hiddenLists the accounts that were previously merged into this one, via the shared record-merge engine's history. Read-only and hidden by default; useful for explaining why a duplicate account can no longer be found under its own name.
MergeMergeServerAction (Merge)Merges duplicate accounts into this surviving master via the generic record-merge engine (IRecordMergeService) - the same entity-agnostic Merge that cases use; despite the seeded description mentioning cases, on Account it merges accounts.
NewNewNewNew
SetStatusSet StatusServerAction (SetStatus)Opens the status form for the account. The server side does not change the status: the handler only reads an optional notify flag from the arguments and returns it, so whatever the status ends up as was written by the form's own field binding, not by this action.
SetStatusBulkSetStatusServerAction (SetStatus)The list-header variant of the status action, requiring a selection. It dispatches to the same server handler, which performs no status change of its own - so on a bulk selection with no form behind it, nothing is updated.
SetStatusLineSet Status LineServerAction (SetStatus)The row-level variant of the status action, opening the same status form from a list row and dispatching to the same server handler, which performs no status change itself.
UIActionUI ActionUIActionUI Action

Validations

ValidationApplies toError messageNotes
Last Name Mandatory for Customer Account ValidationLastName, Error, inactiveLast Name is mandatory for Customer Accounts.Last name is mandatory for customer account.
← Using entity screens Account Balance →