Open Checkbook 101
Schema and Examples
Welcome to Tyler Technologies' Open Checkbook experience. This page is designed to provide documentation that will help your team better understand the Open Checkbook 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:
- Understanding Schemas
- Schema Documentation
- Customer Examples
- Additional Resources
Understanding the Schemas
There are two schemas we will cover: Open Checkbook requires one dataset detailing expenditures information ("The Expenditures Dataset") to function and recommends one dataset detailing vendor or recipient information ("The Vendor Dataset") to inform constituents about which organizations receive payment.
The schemas themselves are linked below. Within the schema documentation, you'll find three field types:
- Required Fields: These fields are required by Open Expenditures to function. Think of these as the data that you simply could not report spending without. For example, a payment date or an amount paid.
- Recommended Fields: These fields are not required, but including them will allow users to see a richer picture of your spending information. For example, a description for each expense or a transaction number.
- Optional Fields: These fields are useful for analysts or power-users accessing the information, or for adding a deeper level of hierarchy. For example, payment method or additional classifications of department hierarchy at which the expense was made.
For the full documentation of the Open Checkbook schema, select the link below:
Open Checkbook Schema (Downloadable PDF)
Below are examples of actual customers' Open Checkbook 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 the application.
Our support team has put together a list of articles to assist with your implementation. Find support articles here.
Have questions? Feel free to reach out to your program manager, customer success manager, or our support team at firstname.lastname@example.org