Open Payroll 101
Schema and Examples
Welcome to Socrata's Open Payroll experience. This page is designed to provide documentation that will help your team better understand the Open Payroll application, and how you'll need to structure your data so that the application can read and display information in meaningful ways.
This page includes:
- Introducing Open Payroll
- Understanding Schemas
- Schema Documentation
- Customer Examples
- Additional Resources
Introducing Open Payroll
Open Payroll is a powerful but simple tool that allows your constituents and internal staff to see the total compensation of government employees. The primary challenge in implementing the tool is to get your payroll data into the Open Payroll schema - this schema often reflects the format in which Payroll data is already stored
This page is here to help provide more information and context about how your data should be structured, as well as customer examples so that you can see live examples of both datasets as well as the finished product.
Within the schema documentation, you'll find three field types:
- Required Fields: These fields are required by Open Payroll to function. Think of these as the data that you simply could not report payroll without. For example, position titles, employee IDs (not employee names) , and total annual pay.
- Recommended Fields: These fields are not required, but including them will allow users to see a richer picture of your spending information. For example, different breakdowns of the total annual pay, such as overtime pay, and benefits pay. Note that employee first/last names are recommended for transparency, but not necessarily required.
- Optional Fields: These fields are useful for analysts or power-users accessing the information, or for adding a deeper level of hierarchy. For example, listing the union(s) or bargaining group(s) that employees belong to. Additionally, you can include a "projected total pay", so that users can compare this projected amount with the end-of-year actuals.
For the full documentation of the Open Payroll schema, click the link below:
Below are examples of actual customers' Open Payroll implementations, from both the application level as well as the data level. Use the below examples to explore how the data is structured, and how it is displayed in the final version of an application.