Payroll Component — entity reference

The reusable pay-component master: every earning, deduction, employer contribution and reimbursement a payroll company pays, defined once with its type, statutory nature, taxability and the two GL accounts posting uses. Salary-structure lines and payroll adjustments point at a component. When a run is calculated, the component's Component Type, Statutory Type, Taxability, Is Statutory, Is Proratable and both GL accounts are copied onto every calculated line and override the structure line's own legacy fields. The amount itself always comes from the structure line (its Calculation Type and Value), never from the component. On the standard form the Component Type, Calculation Type, Statutory Type and Taxability fields are plain text boxes, so the stored value must be typed exactly (for example EmployerContribution, not Employer Contribution); a type the engine does not recognise is counted in no total and skipped at posting. Name and Component Code must be unique across the whole tenant. Is Active is not checked by the calculation. Found in the Payroll app under Settings, Pay Structure, Payroll Components.

Fields

Field	Label	Type	Required	What it does
`BasedOnComponentCodes`	Based On Component Codes	Text		Descriptive only. A comma-separated list of the component codes a formula would depend on. Nothing reads it.
`CalculationType`	Calculation Type	PickList	Yes	Descriptive only. Required on the form, but the run never reads it: the amount comes from the structure line's own Calculation Type and Value. Values Fixed, Percentage, Formula, Slab or Manual. Values: Fixed, Percentage, Formula, Slab, Manual.
`ComponentCode`	Component Code	Text, unique	Yes	A short code for the component, for example BASIC. Required and unique across the whole tenant. The TDS work sheet groups earning rows by this code; no calculation resolves it.
`ComponentType`	Component Type	PickList	Yes	How the amount counts. Type exactly Earning, Deduction, EmployerContribution or Reimbursement (case matters, no spaces), because the form shows a text box. Earnings and reimbursements add to gross pay and need the GL Account at posting; deductions reduce net pay and need the Payable GL Account; employer contributions cost the company without touching net pay and need both. Any other text is counted in no total and posts nothing. Overrides the structure line's own Component Type. Values: Earning, Deduction, Employer Contribution, Reimbursement.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DisplayOnPayslip`	Display On Payslip	Boolean		Descriptive only. Shown on the record page, not on the create form. Payslips are built from the employee's run totals whatever this flag says.
`FormulaExpression`	Formula Expression	Text		Descriptive only. Formula text is never evaluated; a structure line set to Formula pays its stored Value.
`GLAccountId`	GL Account	Lookup → GLAccount	Yes	The expense account debited at posting for earnings, reimbursements and employer contributions. Required on the form for every component; deductions ignore it. Copied onto the calculated lines when the run is calculated, so a change affects only runs calculated afterwards. The picker lists every GL account, so choose one of the payroll company's own accounts.
`Id`	Id	Guid	Yes
`IsActive`	Is Active	Boolean		Descriptive only. The run does not check it, so an inactive component that a structure line or adjustment still uses keeps being paid and posted, and the Payroll Component pickers still offer it. To stop paying a component, deactivate or remove the structure lines that use it.
`IsArrearEligible`	Is Arrear Eligible	Boolean		Descriptive only. Arrears are entered as payroll adjustments, and nothing checks this flag.
`IsPartOfCTC`	Is Part Of CTC	Boolean		Descriptive only. Percentage-of-CTC structure lines read the compensation record's CTC figure, not a sum of components flagged here.
`IsPartOfGross`	Is Part Of Gross	Boolean		Descriptive only. Whether an amount adds to gross pay is decided by Component Type.
`IsPartOfNetPay`	Is Part Of Net Pay	Boolean		Descriptive only. Whether an amount changes net pay is decided by Component Type.
`IsProratable`	Is Proratable	Boolean		When ticked, loss-of-pay days reduce the amount by payable days over calendar days, and the shortfall on earnings and reimbursements becomes the employee's loss-of-pay amount. Unticked (false) switches proration off even if the structure line says Pro-rata; left untouched (empty), the structure line's Pro-rata box decides.
`IsStatutory`	Is Statutory	Boolean		Marks the component as statutory. Copied onto calculated lines as Is Statutory, which nothing else reads. What a statutory component does is decided by Statutory Type.
`Label`	Label	Text		Not on the standard forms. When filled (for example by import) the TDS work sheet shows it instead of the Name for the component's earning row.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text, unique	Yes	The component's name, for example Basic or PF Employee Contribution. Required and unique across the whole tenant, so a second company needs its own distinct name. It is what the Payroll Component pickers on structure lines and adjustments show, and the label the TDS work sheet uses for an earning row.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The payroll company the component belongs to, picked from partner accounts. For organising only: the calculation uses whatever component a structure line names, whatever its company. Hidden on tenants that run a single company.
`PayableGLAccountId`	Payable GL Account	Lookup → GLAccount	Yes	The liability account credited at posting for deductions and employer contributions, for example PF Payable. Required on the form for every component; earnings and reimbursements ignore it (their net pay goes to the company's Payroll Payable control account). Copied onto the calculated lines when the run is calculated.
`RecordTypeId`	Record Type	Guid, hidden
`SortOrder`	Sort Order	Number		Meant to order lines on the register and payslip, and preferred over the structure line's Sequence when set. It is on no standard form, so it stays empty and the structure line's Sequence decides. Adjustment lines use 1000 and loan recovery lines 2000.
`StatutoryType`	Statutory Type	PickList		The statutory scheme the component belongs to. Type exactly PF, ESI, PT, TDS, LWF or Gratuity in capitals as shown. PT together with a structure line whose Calculation Type is Slab takes the amount from the professional tax slab table; TDS takes the month's TDS projection. Deductions typed PF, ESI or TDS also add to the employee row's PF, ESI or TDS totals. LWF and Gratuity change nothing beyond the label. Overrides the structure line's Statutory Flag. Values: PF, ESI, PT, TDS, LWF, Gratuity.
`Taxability`	Taxability	PickList		Type exactly Taxable, NonTaxable or PartiallyTaxable. Only Taxable ticks Is Taxable on the calculated lines; NonTaxable and PartiallyTaxable both leave it unticked, and a blank value uses the structure line's own Taxable box. It is a marker only: no amount, including salary TDS, changes with it. Values: Taxable, Non Taxable, Partially Taxable.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	BulkDelete
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete this PayrollComponent.
`DeleteHeader`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit this PayrollComponent.
`EditHEader`	Edit	Edit	Edit
`EditInLine`	Edit	EditInline	Edit
`New`	New	New	Create a PayrollComponent.

Lookup filters

Filter	Lookup field	Notes
PartnerAccountFilter	`PartnerAccountId`

Account — looks up via PartnerAccountId
GLAccount — looks up via PayableGLAccountId
UserAccount — looks up via OwnerId
GLAccount — looks up via GLAccountId
UserAccount — looks up via ModifiedById
UserAccount — looks up via CreatedById
ExpenseClaim — referenced by via PayrollComponentId
PayrollRunComponentLine — referenced by via PayrollComponentId
PayrollAdjustment — referenced by via PayrollComponentId

Payroll Component — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics