Reports¶
Reports in paiyroll® support a variety of functions including:
The electronic equivalent of a paper report. Examples:
Payslips
Pre-approval reports showing summary information about a pay run.
Analytic reports covering, for example multiple pay runs.
Automated sending of information. Examples:
Sending information about a pay run to the tax authority.
Sending information about pension contributions to a pension provider.
Automated receiving of information. This is covered in more detail under Data Feeds, but examples include:
Updating company or worker tax information using information fetched from the tax authority.
Uploading worker’s Pay Item values using information fetched from an external file or system.
Reports can have upto two aspects which reflect this diversity:
- submission aspect:
The submission aspect performs the automated sending or receiving of information using Workflow Definitions to handle the automated steps involved.
- view aspect:
The view aspect is typically invoked by clicking on a document name on the My Documents page or the history of an entry on the My Data Feeds. Depending on the type of report, the report can be viewed in (or saved or printed from) the browser, or can be downloaded as needed. For convenience, additional links are provided which can download multiple related documents in one step:
An administrator can fetch all the pre-approval reports for a pay run before it is approved, or all reports for a pay run afterwards.
A worker can fetch all their pay slips for a tax year.
Report Definitions¶
At configuration time Report Definitions instantiate Report Templates for use by a Company, and the available choices are by the governed by the Company’s country.
Note that any password settings are stored in encrypted form. However, unlike user passwords, they must be decrypted for use, so it is recommended that the browser is exited after any interaction with passwords in Report Definitions.
Report Templates¶
Reports Definitions are based on Report Templates which fall into Categories which define when they are invoked and Groups by functional area:
Category |
Notes |
---|---|
Analytics |
See Analytics. |
Data feed using APIs |
See Data Feeds. |
Data feed requiring manual input |
See Data Feeds. |
Pay run review |
Invoked after a pay run to provide information relevant to approval of the run. |
Pay run approved |
Invoked after a pay run is approved. (Also invoked where possible before approval as a dry-run to verify credentials and, in some cases, even content). |
Employee pay run |
Invoked by a worker in order to view information about a pay run, notably their pay slip. |
Employee end tax year |
Invoked on each worker at the end of the tax year. For example, in the ‘GB’ country, this includes P60 generation. |
Employee end employment |
Invoked on each worker at the end of their employment. For example, in the ‘GB’ country, this includes P45 generation. |
Group |
Notes |
---|---|
Accounting |
Integration with accounting/journalling. |
Statutory |
Integration with taxation and social security systems, and other legislatively-oriented outputs. |
Pension |
Integration with pension providers. |
Banking |
Integration with banks and similar payment systems. |
HR and Time-and-Attendance |
Integration with HR or Time-and-Attendance systems, typically for Employee details and Holiday or Shift work information. |
Other |
Pre-approval reports and anything else. |
Report Templates are associated with a jurisdiction, and a Company can only use those matching its jurisdiction, or “Universal”, from the table below.
Name |
Description |
Jurisdiction |
Group |
---|---|---|---|
Analytics |
|||
Finance Journal |
Financial rollup of pay runs |
Universal |
Accounting |
Data feed pay run |
|||
GB CIS Verify |
Construction Industry Scheme (CIS) fetch tax rates and verification numbers |
GB |
Statutory |
GB Cezanne HR |
Cezanne HR API-based upload |
GB |
HR/T&A |
GB HMRC DPS |
HMRC Data Provisioning Service |
GB |
Statutory |
GB NEST Opt-Out |
AE NEST web services opt-outs |
GB |
Pension |
GB People HR |
GB People HR |
GB |
HR/T&A |
GB People’s Pension opt-outs |
Fetch pension opt-outs |
GB |
Pension |
Data feed start tax year |
|||
GB PAYE tax code changer (P9X) |
Pre-start of tax year processing |
GB |
Statutory |
Data feed end tax year |
|||
Data feed daily |
|||
GB Driver Recruitment Software |
Driver Recruitment Software API-based upload |
GB |
HR/T&A |
GB Upload workers from Network |
Networked version of “GB Upload workers from CSV” |
GB |
HR/T&A |
Upload holiday bookings from Network |
Networked version of “Upload holiday bookings from CSV” |
Universal |
HR/T&A |
Upload salaries from Network |
Networked version of “Upload salaries from CSV” |
Universal |
HR/T&A |
Upload shifts from Network |
Networked version of “Upload shifts from CSV” |
Universal |
HR/T&A |
Data feed requiring manual input |
|||
GB Upload workers from CSV |
Add or update workers |
GB |
HR/T&A |
Scale Uplifter |
Scale Uplifter |
Universal |
Other |
Upload holiday bookings from CSV |
Upload holiday bookings from CSV |
Universal |
HR/T&A |
Upload salaries from CSV |
Upload salaries from CSV |
Universal |
HR/T&A |
Upload shifts from CSV |
Uses PayPer-based shifts |
Universal |
HR/T&A |
Pay run review |
|||
Jinja (Company pre-approval) |
Jinja (Company pre-approval) |
Universal |
Other |
Pre-approval summary2 |
Pre-approval summary spreadsheet |
Universal |
Other |
Timesheets |
Timesheets in period |
Universal |
Other |
Worker payment (PDF) |
Worker payment PDF file format |
Universal |
Other |
Pay run approved |
|||
GB AEGON contribution |
GB AEGON contribution (csv) |
GB |
Pension |
GB AEGON submit new members |
GB AEGON submit new members (csv) |
GB |
Pension |
GB Aviva My Business contribution |
GB Aviva My Business contribution (csv) |
GB |
Pension |
GB Aviva My Business member |
GB Aviva My Business member (csv) |
GB |
Pension |
GB BACS Barclays |
Barclays BACS File Format |
GB |
Banking |
GB BACS Lloyds |
BACS CSV file for Lloyds |
GB |
Banking |
GB BACS Santander |
Santander BACS File Format |
GB |
Banking |
GB BACS Standard 18 |
Generic GB BACS file report |
GB |
Banking |
GB CIS 300 |
Construction Industry Scheme (CIS) submit pay and tax details |
GB |
Statutory |
GB NEST Enrol and Contribute |
AE NEST web services contribution and enrollment |
GB |
Pension |
GB NEST contribution |
AE NEST contribution schedule |
GB |
Pension |
GB NEST member |
AE NEST member enrolment |
GB |
Pension |
GB NOW Pensions generic input |
GB NOW Pensions generic input (csv) |
GB |
Pension |
GB Options Pensions eConnect |
GB Options Pensions eConnect (csv) |
GB |
Pension |
GB PAPDIS 11 |
AE PAPDIS 1.1 |
GB |
Pension |
GB Pension letters |
GB Pension letters |
GB |
Pension |
GB People’s Pension contributions |
Submit pension contributions |
GB |
Pension |
GB People’s Pension full file |
GB People’s Pension full file (csv) |
GB |
Pension |
GB RTI EPS |
HMRC Employer Payment Summary |
GB |
Statutory |
GB RTI FPS |
HMRC Full Payment Submission |
GB |
Statutory |
GB Royal London contribution |
GB Royal London contribution (csv) |
GB |
Pension |
GB Royal London member |
GB Royal London member (csv) |
GB |
Pension |
GB Salvus Secure Upload |
GB Salvus Secure Upload (csv) |
GB |
Pension |
GB Scottish Widows GPP contribution |
GB Scottish Widows GPP contribution (csv) |
GB |
Pension |
GB Scottish Widows GPP member |
GB Scottish Widows GPP member (xlsx) |
GB |
Pension |
GB Standard Life contribution |
GB Standard Life contribution |
GB |
Pension |
GB Standard Life join members |
GB Standard Life join members |
GB |
Pension |
GB Teachers Pension MCR |
GB Teachers Pension MCR (csv) |
GB |
Pension |
GB True Potential contribution |
GB True Potential contribution |
GB |
Pension |
GB True Potential enrol employees |
GB True Potential enrol employees |
GB |
Pension |
GB Wage analysis |
GB Wage analysis |
GB |
Statutory |
GB Xero journal |
Submit payroll journal |
GB |
Accounting |
Worker payment (txt) |
Worker payment text file format |
Universal |
Other |
Employee pay run |
|||
Jinja (Employee pay run) |
Jinja Template - Employee pay run category |
Universal |
Other |
Payslip |
Payslip |
Universal |
Other |
Employee end tax year |
|||
GB P60 |
Annual tax summary |
GB |
Statutory |
Employee end employment |
|||
GB P45 |
Employment end summary |
GB |
Statutory |
Reporting engines¶
Report Templates are implemented using different engines depending on the nature of the report. These engines form the basis of the customisability (for text-based reports), behaviour of the report (for network-centric reports) and so on as described here.
Text files, flat¶
Flat text files can be specified using the following settings:
- Header template:
Header
- Row template:
Body specification
- Trailer template:
Footer
- Filename:
Output filename
Pre-defined templates using this engine are provided for common GB usage, and Universal usage, but definitions using these templates can be easily repurposed to generate any text output using the Header, Row and Trailer settings. Each setting is a string written using a macro language. The macro language can specify:
Fixed text.
Data items specified using the notation {dot.qualified.name}. Any part of the content of a Pay Run snapshot can be selected in this way. Generally the prefix of the name is just the key hierarchy in the snapshot, though for the “Row template”, the current employee is implicitly selected.
In addition, some predefined dot.qualified.names are added by the engine itself for each template:
- actual_t:
Header and Footer.
- pay_pence:
Row
- count:
Trailer.
- total:
Trailer.
- total_pay_pence:
Trailer
Formatting options.
For example “Row template” might be set to:
{bankdetail.sort_code}/{bankdetail.account_number} <- {pay_pence:>011}{company.legal_name:<18.18}{actual_t:%d%m%Y}
to produce output like this:
200103/12345678 <- 00123456789Acme Shift Work Lt01021952
452212/23456789 <- 00000002323Acme Shift Work Lt01021952
Text files, general¶
More complex text-based files including HTML, CSV, XML and so on are supported using the Jinja system. Jinja-based Report Templates have the following settings:
- Filename:
Output file (.pdf, .html, txt, csv, xml, …)
- Template:
Jinja2 template text
- Filename:
Output file (.pdf, .html, txt, csv, xml, …)
- Template:
Jinja2 template text
Separate Universal Report Templates are provided for each of several report categories, along with sample Jinja2 template text in the Universal Jinja (Employee pay run) section and following sections.
PDF JasperReports¶
PDF Report Templates based on JasperReports have one standard setting:
- Locale:
Specifies a POSIX Locale for the report, e.g. en_GB, en_US or de_GE.
Networked submissions¶
This supports the electronic submission of data to external agencies. Reports Definitions using these templates typically have some kind of credential settings; where needed these are stored in encrypted form.
These reports also have both a submission aspect and a view aspect.
GB Accounting Reports¶
GB Xero Journal¶
Support for Xero Journal accounting. Each report definition specifies:
- Xero authorisation:
Enable delegated access
- Journal configuration:
Journal items by schedule
GB Banking Reports¶
GB BACS Barclays¶
Support for BACS transfers to Barclays bank. Each report definition specifies:
- Header template:
Header
- Row template:
Body specification
- Trailer template:
Footer
- Filename:
Output filename
Report Definitions can be tailored as needed, see Universal text file.
GB BACS Lloyds¶
Support for BACS transfers to Lloyds bank. Each report definition specifies:
- Header template:
Header
- Row template:
Body specification
- Trailer template:
Footer
- Filename:
Output filename
Report Definitions can be tailored as needed, see Universal text file.
GB BACS Santander¶
Support for BACS transfers to Santander. Each report definition specifies:
- Header template:
Header
- Row template:
Body specification
- Trailer template:
Footer
- Filename:
Output filename
Report Definitions can be tailored as needed, see Universal text file.
GB BACS Standard 18¶
Support for BACS transfers to any Bank supporting the Standard 18 format e.g. HSBC or Bank of Ireland. Each report definition specifies:
- Header template:
Header
- Row template:
Body specification
- Trailer template:
Footer
- Filename:
Output filename
Report Definitions can be tailored as needed, see Universal text file.
GB Pension Reports¶
GB Pension Letters¶
The Pension Regulator (TPR) specified pension letters are automatically generated and sent by e-mail.
Each report definition specifies:
- Signature:
Custom signature
GB AEGON¶
GB AEGON contribution upload¶
CSV file for AEGON Automatic Enrolment payments. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB AEGON member enrolment¶
CSV format file for AEGON Automatic Enrolment submit new members (enrolment) Spreadsheet. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
GB Aviva¶
GB Aviva contribution upload¶
CSV file for Aviva Automatic Enrolment contribution. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB Aviva member enrolment¶
CSV format file for Aviva Automatic Enrolment members enrolment Spreadsheet. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
GB NEST¶
Notes:
Reports are generated/ submitted for Scheduled pay runs. Custom or OnDemand pay runs will not include any report content – instead all associated data will be included in the next Scheduled pay run report/submission.
Support is provided for NEST integration using both CSV files and Web Service APIs.
GB NEST contribution¶
Text-based support for NEST Automatic Enrolment payments. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
See also text-based enrolment support and web-services based NEST support.
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB NEST member¶
Text-based support for NEST Automatic Enrolment enrolment. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
See also text-based payment support and web-services based NEST support.
Report Definitions can be tailored as needed, see Universal text file.
GB NEST Enrol and Contribute¶
Web-services-based support for NEST Automatic Enrolment enrolment and payments. Each report definition specifies:
- Scheme:
NEST scheme definition
- NEST username:
Credentials
- NEST password:
Credentials
See also NEST Opt-Out support.
GB NEST Opt-Out¶
Data feed for NEST Automatic Enrolment opt-outs. Each report definition specifies:
- Dry run:
If set, discard results and some errors become warnings
- Scheme:
NEST scheme definition
- NEST username:
Credentials
- NEST password:
Credentials
See also web-services based NEST support.
GB NOW Pensions¶
GB NOW Pensions generic input¶
CSV file for NOW Pensions Automatic Enrolment. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB Options Pensions¶
GB Options Pension eConnect Member Data Upload¶
CSV file for eConnect Member Data Upload. . Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB PAPDIS 11¶
Notes:
Reports are generated/ submitted for Scheduled pay runs. Custom or OnDemand pay runs will not include any report content – instead all associated data will be included in the next Scheduled pay run report/submission.
Text-based support for PAPDIS Automatic Enrolment enrolments and payments. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
GB The People’s Pension¶
Notes:
Reports are generated/ submitted for Scheduled pay runs. Custom or OnDemand pay runs will not include any report content – instead all associated data will be included in the next Scheduled pay run report/submission.
GB People’s Pension Enrol and Contribute¶
Support for The People’s Pension Automatic Enrolment enrolment and payments. Each report definition specifies:
- People’s Pension authorisation:
Enable delegated access
- Scheme:
People’s Pension scheme definition
See also People’s Pension Opt-Out support.
GB People’s Pension Opt-Out¶
Data feed for NEST Automatic Enrolment opt-outs. Each report definition specifies:
- Dry run:
If set, discard results and some errors become warnings
- People’s Pension authorisation:
Enable delegated access
- Scheme:
People’s Pension scheme definition
GB People’s Pension Full File CSV¶
A full file contains both employee data and contribution amounts to be uploaded every pay period in CSV format. All schemes which relate to a single reference must be specified in the report definition settings:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
GB Royal London¶
GB Royal London contribution upload¶
CSV file for Royal London Automatic Enrolment contribution. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB Royal London member enrolment¶
CSV format file for Royal London Automatic Enrolment members enrolment Spreadsheet. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
GB Salvus Master Trust¶
GB Salvus Secure Upload¶
CSV file for Salvus Secure Upload. . Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB Scottish Widows¶
GB Scottish Widows contribution upload¶
CSV file for Scottish Widows Automatic Enrolment payments. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB Scottish Widows member enrolment¶
XLS format file for Scottish Widows Automatic Enrolment member enrolment (new joiners) Spreadsheet. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Important
You may need to modify this file to include any specific Lifestyle and fund choices for members.
GB Standard Life¶
GB Standard Life contribution upload¶
CSV file for Standard Life Automatic Enrolment contribution. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB Standard Life member enrolment¶
CSV format file for Standard Life Automatic Enrolment members enrolment Spreadsheet. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
GB Teachers Pensions (TPS)¶
GB TPS Monthly Data Collection (MDC)¶
CSV file for Monthly Data Collection (MDC). This is used for providing service and contribution information. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB True Potential¶
GB True Potential contribution upload¶
XLSX file for True Potential Automatic Enrolment contribution. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
Report Definitions can be tailored as needed, see Universal text file.
Notes:
Text reports assume that only a single AE Pay Item is connected to the Pension contributions (worker) [report buss]. If other Pay Items are also connected, then these values be included in the report and therefore invalidate the expected output.
GB True Potential enrol employees¶
XLSX format file for True Potential Automatic Enrolment enrol employees Spreadsheet. Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Scheme names:
Comma separated
This scheme requires Marital status that paiyroll® does not hold. Therefore all enrolled employees will be marked as ‘Single’ in the file. Be sure to make any required modifications before uploading the file.
The address feels for Town is mandatory, and therefore all employees who will be enrolled must have the Town in address line 4 or address line 3.
GB Statutory Reports¶
GB P45¶
A formal report of the leavers in a pay run. Each report definition specifies:
- Locale:
Locale, e.g. en_US, de_GE
- employee_id:
Specifies the employee id to generate report for; empty mean all employees
GB P60¶
A formal summary of the payments to each worker in a tax year. Each report definition specifies:
- Locale:
Locale, e.g. en_US, de_GE
- employee_id:
Specifies the employee id to generate report for; empty mean all employees
GB HMRC CIS Monthly Submission (CIS300)¶
A monthly submission for Construction Industry Scheme subcontractor taxation. It is broadly analagous GB RTI FPS for normally taxed workers. Each report definition specifies:
- Dry run:
If set, discard results and some errors become warnings
- CIS username:
Alternatively, RTI username can be used
- CIS password:
Alternatively, RTI password can be used with RTI username
GB HMRC CIS Verification¶
See GB HMRC CIS Verification Data Feeds.
GB HMRC DPS¶
See GB HMRC DPS Data Feeds.
GB PAYE tax code changer (P9X)¶
See GB PAYE tax code changer (P9X) Data Feed.
GB RTI EPS¶
HMRC Employer Payment Summary. Each report definition specifies:
- Agriculture:
Claim Employment Allowance, when agriculture
- Fisheries and aquaculture:
Claim Employment Allowance, when fisheries and aquaculture
- Road transport:
Claim Employment Allowance, when road transport
- Industrial:
Claim Employment Allowance, when industrial
- Rules do not apply:
Claim Employment Allowance, if rules do not apply
- RTI Name:
Government Gateway user ID
- RTI Password:
Password
- Apprenticeship Levy Allowance:
Pay Apprenticeship Levy, use “-1” if not applicable
- CIS deductions suffered:
Enter total CIS deductions year to date
- Dry run:
Set for Parallel runs. Will not submit to HMRC live server and RTI Name/Password not required
Notes:
See the Changes to Employment Allowance for claiming NIC-based Employment Allowance that apply from April 2020.
GB RTI FPS¶
HMRC Full Payment Submission. Each report definition specifies:
- RTI Name:
Government Gateway user ID
- Late reporting reason:
Late reason GHFDABC
- RTI Password:
Password
- Scheme ceased date:
Usually not set
- Dry run:
Set for Parallel runs. Will not submit to HMRC live server and RTI Name/Password not required
GB Wage Analysis¶
Spreadsheet-based pivot-table friendly report which provides National Minimum Wage (NMW) analysis. The following must be configured according to the type of pay for each worker:
Hours. If you use shift Pay Definitions based on the Per Unit Pay Template, you can include these in this report. This must be done by renaming the first input to any name that includes both the words hour and rate, for example:
Hourly rate
RATE/HOUR
Rate (hourly)
If the Pay Definition input is not renamed, then any related Pay Items will be skipped for this report.
Hours. The number of hours per day/ hours per week is specified in the time-based timesheet scheme. See Universal Time-of-Attendance-based timesheets.
Annual salary. The number of annual hours each year in the workers contract is specified via the Salary Scheme. See Universal Salary.
Piece (output). The benchmark average rate of pieces completed per hour is specified on the piece based timesheet scheme. See Universal Piece-based timesheets.
If workers are provide with accommodation, then an appropriate Pay Item deduction needs to be added to each worker, regardless of whether a deduction is actually made. A comma separated list of all such deduction Pay Definitions must also be specified in the settings of the Wage Analysis report definition.
Each report definition specifies:
- Format:
Spreadsheet file (csv, ods, xlsx)
- Accommodation names:
Pay Item deductions (if used), comma separated
GB HR & Time-and-Attendance Reports¶
GB Upload workers CSV and Network¶
See GB Upload workers Data Feed.
GB Cezanne HR API¶
See GB Cezanne HR API Data Feed.
GB Driver Recruitment Software (DRS) API¶
See GB Driver Recruitment Software (DRS) API Data Feed.
GB PeopleHR API¶
See GB PeopleHR API Data Feed.
Universal Reports¶
Universal Finance Journal¶
See Universal Finance Journal Analytics.
Universal Pre-approval summary2¶
Each report definition specifies:
- Warn on unbalanced journal:
If clear, error on unbalanced journal
- Format:
Spreadsheet file (csv, ods, xlsx)
- Journal configuration:
Journal items by schedule
Universal Payslip¶
Each report definition specifies:
- Locale:
Locale, e.g. en_US, de_GE
- employee_id:
Employee database id to generate report for; empty means all employees
- omit_zero_payslips:
Set to ignoreable [[buss…],[pay item…]] to omit zero payslips
Universal Timesheets¶
This summarises the Timesheet schemes in use, and all approved Timesheets in a pay run. Each report definition specifies:
- Locale:
Locale, e.g. en_US, de_GE
- employee_id:
Employee database id to generate report for; empty means all employees
Universal Upload holiday bookings CSV and Network¶
See Universal Upload holiday bookings Data Feed.
Universal Upload salaries CSV and Network¶
See Universal Upload salaries Data Feed.
Universal Upload shifts CSV and Network¶
See Universal Upload shifts Data Feed.
Universal Worker payment (PDF)¶
A summary of the payments to each worker in a pay run. Each report definition specifies:
- Locale:
Locale, e.g. en_US, de_GE
There is also a configurable text version.
Universal Worker payment (txt)¶
A summary of the payments to each worker in a pay run. Each report definition specifies:
- Header template:
Header
- Row template:
Body specification
- Trailer template:
Footer
- Filename:
Output filename
There is also a PDF version.
Report Definitions can be tailored as needed, see Universal text file.
Universal Jinja (Employee pay run)¶
A Jinja template is a text file which can be used to generate any text-based output file (txt, html, csv, xml). See the guide Creating a Custom Jinja report for example templates below which can be downloaded and tailored as required.