Cost Codes API¶
This user guide describes the Cost Codes integration, which loads cost codes and their descriptions from ERP/Finance into the new Sapio LIMS instance so that spend can be assigned to the correct cost code.
About this Documentation¶
This documentation is intended to help users understand the purpose, architecture, and usage of this project.
The following sections are included:
- Purpose and Features – Describes the purpose of the project, the problems it solves, and its key capabilities.
- High Level Architecture – Provides an overview of the system architecture and how the major components interact.
- How to Use – Explains how users can interact with the project and perform common tasks.
- Example Use Cases – Demonstrates real-world scenarios and examples.
Intended Audience¶
This documentation is useful for:
- Users of the project
- Developers and engineers
- Solution architects
- Support and operational teams
Users will be provided with an overview of the project and what it is designed to achieve. A high-level description of the system architecture is included, but detailed technical implementation or the underlying components that support the project are not covered here.
Nomenclature¶
The following terms and abbreviations appear throughout this documentation:
| Term | Definition |
|---|---|
| Cost code | A code used to assign spend to the correct project or budget. In this integration, a cost code and its description are loaded into Sapio LIMS as a project record. |
| ERP | Enterprise Resource Planning — the finance system that is the source of cost code data. |
| Sapio LIMS | The laboratory information management system into which cost codes are loaded. |
| Integration Hub | The Sanger team that builds and operates this integration, and the sole caller of the API during Phase 1. |
| XAPI (Experience API) | The consumer-facing entry layer that authenticates, validates, and routes incoming requests. |
| PAPI (Process API) | The middle layer that routes requests between the Experience and System layers. |
| SAPI (System API) | The backend-facing layer that abstracts Sapio and executes operations against it. |
| Phase 1 / Phase 2 | The two delivery stages: Phase 1 pushes cost codes into Sapio from a file (converted to JSON payload by the Integration Hub) received from Finance; Phase 2 will let Sapio pull cost codes directly from the ERP once it is available. |
Additional Information¶
For questions, support, or further information, please contact the Sanger Integration Hub, integration-hub@sanger.ac.uk