Report Line Merics

This pay run generated object details several metric aspects of the run.



Payroll metrics for a payrun that can be used in reporting.

ReportLineMetrics [Schema]

Name Type Required Description
PaymentDate xsd:date yes The payment date of the payrun.
Payslips xsd:integer yes The total number of payslips generated in the payrun.
ActiveEmployees xsd:integer yes The total number of active employees in the related pay schedule; including period new starters and leavers.
NewStarters xsd:integer yes The total number of new starter in the payrun.
Leavers xsd:integer yes The total number of leavers in the payrun.
EmployeesInPension xsd:integer yes The total number of employees who are members of a pension scheme in the payrun.
EmployeesContribToPension xsd:integer yes The total number of employees contributing to a pension scheme in the payrun
PayFrequency PayFrequency yes The pay frequency of the pay run.

Interits from: ReportLine[Schema]

Name Type Required Description
Value Money yes The monetary value of the reporting line. Maybe positive or negative.
Description xsd:string ( max: 100) yes The description of the report line.
Generated xsd:dateTime yes The date and time the report line was generated.
TaxYear xsd:integer yes The relevant tax year for the report line.
TaxMonth xsd:integer yes The relevant tax month for the report line. Tax months follow the monthly tax periods. Period 1 = April 6th to May 5th.

Example

<?xml version="1.0"?>
<ReportLineMetrics xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Value>123.99</Value>
  <Description>string</Description>
  <Generated>2021-12-01T00:00:00+00:00</Generated>
  <TaxYear>123</TaxYear>
  <TaxMonth>123</TaxMonth>
  <PaymentDate>2021-12-01</PaymentDate>
  <Payslips>123</Payslips>
  <ActiveEmployees>123</ActiveEmployees>
  <NewStarters>123</NewStarters>
  <Leavers>123</Leavers>
  <EmployeesInPension>123</EmployeesInPension>
  <EmployeesContribToPension>123</EmployeesContribToPension>
  <PayFrequency>Weekly</PayFrequency>
</ReportLineMetrics>
{
  "ReportLineMetrics": {
    "Value": "123.99",
    "Description": "string",
    "Generated": "2021-12-01T00:00:00+00:00",
    "TaxYear": "123",
    "TaxMonth": "123",
    "PaymentDate": "2021-12-01",
    "Payslips": "123",
    "ActiveEmployees": "123",
    "NewStarters": "123",
    "Leavers": "123",
    "EmployeesInPension": "123",
    "EmployeesContribToPension": "123",
    "PayFrequency": "Weekly"
  }
}