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

Payroll Component — entity reference

The reusable pay-component master — every earning, deduction, employer contribution and reimbursement a company can pay, defined once with its type, taxability, calculation method, statutory nature and both GL account mappings. Salary-structure lines (SalaryComponent) reference a row here, and at calculation time the master's ComponentType, StatutoryType, Taxability, IsProratable, SortOrder and GL accounts WIN over the equivalent legacy fields on the structure line; the line's own values are only a fallback when it has no master. Because the GL mapping lives here, posting needs no hardcoded account map — and conversely a component missing the mapping its type requires fails the entire post. ComponentType is Earning, Deduction, EmployerContribution or Reimbursement; CalculationType is Fixed, Percentage, Formula, Slab or Manual; StatutoryType, where the component is statutory, is PF, ESI, PT, TDS, LWF or Gratuity.

Fields

FieldLabelTypeRequiredWhat it does
BasedOnComponentCodesBased On Component CodesTextA comma-separated list of the component codes this component's formula depends on.
CalculationTypeCalculation TypePickListYesValues: Fixed, Percentage, Formula, Slab, Manual.
ComponentCodeComponent CodeText, uniqueYesThe short stable identifier for the component, used to reference it from other components' formula dependencies.
ComponentTypeComponent TypePickListYesValues: Earning, Deduction, Employer Contribution, Reimbursement.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DisplayOnPayslipDisplay On PayslipBooleanIntended to control whether the component is shown on the payslip, defaulting to on. No first-party code reads it — payslip breakdowns are projected from every component line of the employee's detail regardless of this flag.
FormulaExpressionFormula ExpressionText
GLAccountIdGL AccountLookup → GLAccountYes
IdIdGuidYes
IsActiveIs ActiveBooleanWhether the master is available for use in salary structures, defaulting to on. Deactivating it does not stop calculation: the engine resolves masters by identifier and applies them regardless, so an inactive component still referenced by a structure line continues to be paid.
IsArrearEligibleIs Arrear EligibleBooleanDeclares that the component may be paid as arrears for an earlier period. It is descriptive only: arrears are entered as PayrollAdjustment records, and nothing in the calculation checks this flag before accepting one.
IsPartOfCTCIs Part Of CTCBooleanDeclares that the component counts toward cost to company. It is a classification flag for structure design and reporting — the calculation does not consult it, and percentage-of-CTC components read the compensation record's CTC figure directly rather than summing flagged components.
IsPartOfGrossIs Part Of GrossBoolean
IsPartOfNetPayIs Part Of Net PayBooleanDeclares that the component should affect take-home pay. The engine ignores it: what actually decides the effect on net is ComponentType, where earnings and reimbursements add and deductions subtract, while employer contributions never touch net.
IsProratableIs ProratableBoolean
IsStatutoryIs StatutoryBoolean
LabelLabelText
ModifiedByIdModified ByLookup → UserAccountYes
NameNameText, uniqueYes
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → Account
PayableGLAccountIdPayable GL AccountLookup → GLAccountYes
RecordTypeIdRecord TypeGuid, hidden
SortOrderSort OrderNumberThe component's position in payslip and breakdown ordering, copied onto every calculated line in preference to the salary structure's own sequence. Keep it below 1000, because adjustment lines are stamped 1000 and loan recovery lines 2000, and those two bands are how downstream logic recognises non-structure lines.
StatutoryTypeStatutory TypePickListValues: PF, ESI, PT, TDS, LWF, Gratuity.
TaxabilityTaxabilityPickListValues: Taxable, Non Taxable, Partially Taxable.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteBulkDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete this PayrollComponent.
DeleteHeaderDeleteDeleteDelete
EditEditEditEdit this PayrollComponent.
EditHEaderEditEditEdit
EditInLineEditEditInlineEdit
NewNewNewCreate a PayrollComponent.

Lookup filters

FilterLookup fieldNotes
PartnerAccountFilterPartnerAccountId