Skip to main content
Lumonic
Betav0.1.0
31 actions · 1 auth method

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

No app registration required. Lumonic issues API keys on request, and each key is sent as-is in the Authorization header…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

31 actions
Action
Description
Import Cashflows
Bulk import cashflows into the system.
Get A Covenant
Retrieve details of a specific covenant by its unique ID.
List Covenants
Retrieve a list of covenants based on query filters.
List Covenant Values
Retrieve covenant values based on query filters.
List Deliverables
Retrieve the recurring reporting obligations entities owe you, and the cadence of each.
List Tasks
Retrieve a list of tasks and their derived status based on query filters.
Get A Document
Retrieve details of a specific document by its unique ID.
List Documents
Retrieve a list of documents based on query filters.
Create Document Upload Targets
Create pre-signed upload targets so files can be sent directly to storage, without passing through the Lumonic API.
Import Documents
Create documents from files already uploaded through /document-uploads/create.
Get A Document Tag
Retrieve details of a specific document tag by its unique ID.
List Document Tags
Retrieve a list of document tags based on query filters.
Get An Entity
Retrieve details of a specific entity by their unique ID.
List Entities
Retrieve a list of all entities.
Create An Entity
Create a new entity in the specified namespace.
Delete An Entity
Delete a specific entity by its unique ID.
Get A Periodic Field
Retrieve details of a specific periodic field by their unique ID.
List Periodic Fields
Retrieve a list of periodic fields based on query filters.
List Periodic Field Values
Retrieve periodic field values based on various filter criteria such as entity IDs, effective dates, field IDs, modifica…
Import Periodic Field Values
Bulk import periodic field values into a cluster.
Get A Static Field
Retrieve details of a specific static field by their unique ID.
List Static Fields
Retrieve a list of static fields based on query filters.
List Static Field Values
Retrieve static field values based on various filter criteria such as entity IDs, field IDs, modification and creation d…
Import Static Field Values
Bulk import static field values into a cluster.
Get A Formula
Retrieve details of a specific formula by its unique ID, including its Lx expression in human-readable format.
List Formulas
Retrieve a list of formulas based on query filters.
List Formula Values
Retrieve formula values based on various filter criteria such as entity IDs, effective dates, formula IDs, and scenario.
Get A Namespace
Retrieve details of a specific namespace by its unique ID.
List Namespaces
Retrieve a list of namespaces based on query filters.
Get A Scenario
Retrieve details of a specific field_scenario by their unique ID.
List Scenarios
Retrieve a list of scenarios based on query filters.