Data Design

Data at HCSS is generally divided into 3 levels: company-wide, business-unit-specific, and job-specific. For example, when selecting an employee from a list, it may be useful to show only employees who are working on a particular job. Employees are available at a company-wide, business-unit, and job level. Equipment is divided in the same manner.

Other resources may only exist at one or two levels. For example, materials exist at the business-unit and job levels only. Pay classes have a company-wide and a business-unit-specific representation. Cost codes only exist at the job level.

Different fields may be available at each level. For example, with materials, the material code is shared across a business unit, but the unit cost may be overridden for each job. This means that the unit cost field is only available at the job-level, while the material code is only writable at the business-unit-level.

This design provides some flexibility, but can be a little bit complex. Look towards the API Reference for guidance on the level an endpoint works at.

📘

The HCSS Terminology Guide explains some of the terms used here.

Please Contact Us if you have any questions on our API data design.