Close APIs
Cairo
http://close-service:8082
Welcome to the documentation for the Close APIs. This documentation provides comprehensive information and resources related to the Close APIs, which offer a set of powerful tools and functionalities for various aspects of management within the Cadency system. Whether it's handling tasks, periods, issues, system values, or entities, these APIs serve as a robust foundation for efficient and streamlined operations."
The Close APIs empower developers and administrators to seamlessly integrate and interact with the Cadency ecosystem. By leveraging these APIs, you can automate key processes, manage user identities, and ensure the consistent management of entities and tasks.
Explore the various API tags listed below to discover the wide range of capabilities offered by the Close APIs:
Overview
he Close APIs facilitate user identity management in Cadency, streamlining the process of managing entity, period, tasks, issues and system values. By integrating with Close API, all entities mentioned above will be managed in Cadency. Key automation processes supported by this integration include: 1. Task Definitions API: Task instances are automatically created when each period is opened, based on predefined task definitions. This tag focuses on managing the intricacies of task generation and assignment. 2. Fiscal Years API: This tag encompasses operations that enable searching for Fiscal Years based on different statuses, facilitating efficient financial year management. 3. Inbox Receivers API: Managing the Inbox is crucial for effective communication and task allocation. This tag provides operations to seamlessly handle Inbox-related processes. 4. System Values: This tag covers operations to manage system-configured values, including task types, account categories, and more. These values play a pivotal role in defining the behavior of the Cadency system. 5. Periods API: Efficiently managing the close period is essential for various financial and operational processes. This tag provides operations to oversee and control the close period. 6. Static Values: Obtain essential close task and issue status values, along with priority values. These static values offer insights into the state and priority of tasks and issues. 7. Tasks API: This tag focuses on task management operations, encompassing everything from task creation to submission actions, enabling effective task lifecycle management. 8. Results Issues API: Effectively search for and retrieve issues using operations provided by this tag, streamlining the process of issue management. 9. Entities API: For a given period, manage entity instances seamlessly using operations offered by this tag. Efficient entity management is vital for financial and operational coherence. 10. Entity Definitions API: Explore entity definition templates, which serve as blueprints for entity instances. This tag offers operations to manage and view these templates, subject to owner or administrator privileges. 11. Stats: Gain insights into statistics related to Tasks and Issues. This tag provides operations to manage and retrieve these valuable statistics.
Authentication
Bearer Authentication
An authentication access token is required to access the Close APIs
Note that:* All requests to the Close APIs should include the token in the Authorization header, i.e. Authorization: Bearer {access token}
.
This is version Cairo
of this API documentation.
Last update on Mar 28, 2025.