Use the Anaplan Financial Consolidation API to control workflows, manage security, retrieve, insert, update, and delete financial data and metadata with external process automations.
The Financial Consolidation API is a secure, web-based API that lets you automate processes within Financial Consolidation. It does this by sending requests and reading responses between Anaplan and other systems.
Once a connection string is established by an administrator in Anaplan, and an encrypted API key is provided, you can send requests to the API service. The server handles any requests to the customer's tenant database. It then gives a response in a JSON-structured format. The protocol used to transport the data is HTTPS. This means client and server communication is encrypted and secure, providing an additional layer of protection for your REST API interactions.
With this API, you can programmatically access, change, and analyze financial data. Use the API to retrieve dimensions, members, and properties to synchronize with an external application. You can also make your financial reporting and consolidation processes easier, control your workflows, and manage users.
This documentation provides an overview of the API authentication, endpoints, requests, and parameters, and their responses.
Purpose
You can use the Financial Consolidation API to:
| Action | Description |
| Discover endpoints | Determine which API endpoints you can use. |
Upload data | Use the API to upload data to a staging table, which is validated and transferred into the model or fact table. |
| Retrieve data | Use the proper root URL, path parameters, and query parameters to retrieve data from Financial Consolidations. For example, you might fetch profit and loss, balance sheet, or cash flow data for specific periods or entities to view alongside your sales data for a particular entity and period within a planning solution. |
| Synchronize dimension information | Get a list of dimensions, their parent-child relationships, and other properties and attributes from Financial Consolidation. Use this information to create a planning solution that'll synchronize metadata and hierarchy information across both systems. |
| Automation and integration | Use the Financial Consolidation REST API calls to automate the start, stop, and retrieve the Run ID of your workflows. For example, start a "Month-End Close" workflow to perform real-time processes and calculations to close the month-end for your organization from an external process manager, web page, or automation manager. |
Use cases
Examples of use cases for the REST API against Anaplan Financial Consolidation would be:
- Update Financial Consolidation data from an external source, like an ERP system or a middleware ETL platform.
- Retrieve Financial Consolidation financial actuals data to incorporate in a downstream planning application or data lake.
- Push plan data into Financial Consolidation, from a planning system, to generate management budget reports.
- Automate user management tasks, perform bulk operations, and update security settings quickly, ensuring a secure environment.
