Payslip — entity reference

One employee's payslip for one payroll run: the month's totals, days paid, year-to-date figures and a masked bank account, copied from the run's employee row when Generate Payslips is run on a calculated payroll run. It holds totals only; the component breakdown stays on the run's component lines, reached through the Payroll Run Detail. Generation creates one Draft slip per employee row and skips rows that already have one. Recalculating the run deletes its slips, and is refused while any of them has Publish Status Published. Publish Payslips on the posted run renders each slip from the Payslip print template, stores the PDF on the slip (File Asset), sets it Published and notifies the employee by push and email; publishing again skips slips that already have their PDF. Print Payslip prints the same Payslip template, and Tax Declaration prints the Form 12BB template filled from the employee.

Fields

Field	Label	Type	Required	What it does
`BranchId`	Branch	Lookup → Branch		Not stored. Values entered here are not saved.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`EmployeeId`	Employee	Lookup → Employee		Not stored. Values entered here are not saved; the employee is identified by Resource.
`FileAssetId`	File Asset	Guid		The payslip's PDF, rendered from the Payslip print template and stored by Publish Payslips. Publishing again after a correction stores a new version of the same file.
`GeneratedUtc`	Generated Utc	Date		When the slip was generated, in UTC. Not the pay date and not the date it was published.
`GrossEarnings`	Gross Earnings	Currency		Total earnings for the month, copied from the run's employee row at generation. Not refreshed if the run changes; recalculate and generate again.
`Id`	Id	Guid	Yes
`Label`	Label	Text
`LopDays`	Lop Days	Decimal		Loss-of-pay days in the period, copied from the run's employee row.
`MaskedBankAccount`	Masked Bank Account	Text		XXXX followed by the last four digits of the employee's bank account on the Resource when the slip was generated. Empty when the Resource has no account; not updated if the account changes later, and never used for payment.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text, unique	Yes	The payslip number. Set at generation from the tenant's active Payslip document numbering setting, or, when there is none, PS- followed by the generation date (DDMMYYYY) and a six-digit running number.
`NetPay`	Net Pay	Currency		Gross earnings minus total deductions, copied from the run's employee row at generation.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The company that pays the employee, copied from the payroll run. Year-to-date figures only count run rows of this company.
`PayableDays`	Payable Days	Decimal		Days paid in the period, copied from the run's employee row: the calendar days of the period minus unpaid leave.
`PayrollPeriodId`	Payroll Period	Lookup → PayrollPeriod		The pay period the slip covers, taken from the run's employee row or, if that has none, from the run. Use it rather than Generated Utc to group slips by month.
`PayrollRunDetailId`	Payroll Run Detail	Lookup → PayrollRunDetail		The employee row of the run this slip was generated from, and the key that stops a second slip being generated for the same row. Open it to see the component lines behind the slip's totals.
`PayrollRunId`	Payroll Run	Lookup → PayrollRun		The payroll run the slip was generated from. Recalculating this run deletes the slip unless it is Published, in which case the recalculation is refused.
`PublishStatus`	Publish Status	PickList		Draft or Published. Generation writes Draft; Publish Payslips on the posted run writes Published once the slip's PDF is stored, and notifies the employee. It can also be typed in place on the payslip page. Exactly Published stops the payroll run from being recalculated. It does not lock the slip against editing. Values: Draft, Published.
`RecordTypeId`	Record Type	Guid, hidden
`ResourceId`	Resource	Lookup → Resource		The employee's person record, copied from the run's employee row. The masked bank account is taken from this record.
`TotalDeductions`	Total Deductions	Currency		Total deductions for the month, copied from the run's employee row at generation.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes
`YtdGross`	Ytd Gross	Currency		Gross earnings so far in the fiscal year: the sum over every run row of the same employee and company whose payroll period falls in the fiscal year containing this run's period (the company's fiscal year, or April to March when none is defined). Includes this run and unposted runs, and is fixed when the slip is generated.
`YtdTax`	Ytd Tax	Currency		Salary TDS so far in the fiscal year, summed over the same run rows as Ytd Gross. Fixed when the slip is generated.

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete the selected records.
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete this Payslip.
`DeleteRecord`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit this Payslip.
`EditInLine`	Edit	EditInline	Edit
`EditRecord`	Edit	Edit	Edit
`Form16`	Form 16	UIAction	Form 16
`New`	New	New	Create a Payslip.
`PrintPayslip`	Print Payslip	Print	Print the payslip as a PDF from the Payslip document template.
`TaxDeclaration`	Tax Declaration	Print	Tax Declaration
`View`	View	View	View this Payslip.

Lookup filters

Filter	Lookup field	Notes
BranchFilter	`BranchId`	BranchFilter
PartnerAccountFilter	`PartnerAccountId`	PartnerAccountFilter

PayrollRun — looks up via PayrollRunId
UserAccount — looks up via OwnerId
Employee — looks up via EmployeeId
Account — looks up via PartnerAccountId
Resource — looks up via ResourceId
UserAccount — looks up via CreatedById
PayrollRunDetail — looks up via PayrollRunDetailId
Branch — looks up via BranchId
UserAccount — looks up via ModifiedById
PayrollPeriod — looks up via PayrollPeriodId
Employee — referenced by via PayslipId

Payslip — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics