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

Payroll Period — entity reference

One pay cycle of one company, usually a calendar month: the dates a payroll run calculates and posts against. A payroll run points at a period; calculation uses its Start Date and End Date for proration and loss of pay, posting dates the accrual journal with its Pay Date (else End Date), and payroll adjustments, monthly TDS projections, loan recoveries, payslips and salary-TDS challans are tied to the same period record. It is separate from the accounting fiscal period: the payroll journal lands in whichever fiscal period covers its date. Periods are created by hand in the Payroll app; nothing generates them, nothing changes their Status, and nothing stops two periods from covering the same dates.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → BranchYesRequired on the form and limited to the chosen company's branches. It does not decide who is paid: the run selects employees by its own company, and the accrual journal carries the run's branch. Cost analysis that splits payroll by branch attributes a branch-specific period's pay to this branch.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
EndDateEnd DateDateThe last calendar day of the pay cycle. Besides closing the calculation window it decides the financial year and remaining months for the monthly TDS projection (Project TDS does nothing when it is blank), switches professional tax to the February slabs when it falls in February, places the period's salary TDS in a TDS return quarter, tags the salary-TDS challan name, and dates the accrual journal when Pay Date is blank.
FiscalPeriodIdFiscal PeriodLookup → FiscalPeriodYesThe accounting fiscal period the cycle belongs to, required on the form. It is a reference only: payroll posting does not read it, and the accrual journal lands in the fiscal period that covers its date. The picker is not filtered by company.
IdIdGuidYes
InputCutoffDateInput Cutoff DateDateThe intended deadline for the cycle's payroll inputs. It is advisory: nothing reads it, and adjustments or declarations entered after it are still picked up when the run is calculated again.
LabelLabelTextAn optional second caption. It is on no seeded form; the related-party disclosure falls back to it when Period Name is blank.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameText, uniqueYesThe period's identifying name, typed by you because no automatic naming is seeded. It must be unique across the whole tenant, so include the company when several companies run payroll (for example a company code plus the month). It is the name the Payroll Period pickers show, and the mobile home screen titles a payroll run with it.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountYesThe company whose payroll this cycle is; the picker lists your own companies only. Payslip year-to-date totals and the TDS projection only count periods of the run's company, so a period on the wrong company drops out of them. The run's own Partner Account, not this field, decides which employees are paid.
PayDatePay DateDateThe salary date for the cycle. Posting a payroll run dates its accrual journal on this date, falling back to End Date and then to the posting day, so the journal lands in the fiscal period that covers it.
PayrollFrequencyPayroll FrequencyPickListThe intended cadence: Monthly, Weekly, Biweekly or Daily, prefilled with Monthly. The seeded forms show it as a text box. It is descriptive only: calculation works from Start Date and End Date, so the value changes neither proration nor how often runs happen. Values: Monthly, Weekly, Biweekly, Daily.
PeriodNamePeriod NameTextA free-text human name for the cycle, such as the month and year. Nothing parses it: runs, adjustments and challans link to the period record itself, never to this text. The related-party disclosure uses it as the label of payroll rows.
RecordTypeIdRecord TypeGuid, hidden
StartDateStart DateDateThe first calendar day of the pay cycle. With End Date it sets the calculation window: total days are counted from Start Date to End Date inclusive, and approved unpaid leave overlapping the window becomes loss-of-pay days. If either date is blank the run pays every employee in full with no proration or loss of pay. Payslip year-to-date totals also select periods by Start Date, so a period without one drops out of them.
StatusStatusPickListPrefilled with Open when the period is created. It is on no seeded form, no process changes it and nothing reads it, so Closed or Locked does not stop runs, adjustments or postings against the period. Values: Open, Processing, Approved, Paid, Closed, Locked.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete this PayrollPeriod.
DeleteRecordDeleteDeleteDelete
EditEditEditEdit this PayrollPeriod.
EditInLineEditEditInlineEdit
EditRecordEditEditEdit
NewNewNewCreate a PayrollPeriod.
ViewViewViewView this PayrollPeriod.

Lookup filters

FilterLookup fieldNotes
BranchFilterBranchId
PartnerAccountFilterPartnerAccountId