> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lumonic

> How to set up the Lumonic connector, plus the actions that are available.

![Lumonic](https://stackone-logos.com/api/lumonic/filled/svg)

Betav0.1.0[See changelog](/connectors/lumonic/changelog.md)

[31 actions](#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](/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · API Key](/connectors/lumonic/guides/connector-profile/api-key.md)**
>
> 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](/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · API Key](/connectors/lumonic/guides/link-account/api-key.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks.md).

## Actions

31 actions

ActionDescription

Import Cashflows`lumonic_import_cashflows`

Bulk import cashflows into the system.

Get A Covenant`lumonic_get_covenant`

Retrieve details of a specific covenant by its unique ID.

List Covenants`lumonic_list_covenants`

Retrieve a list of covenants based on query filters.

List Covenant Values`lumonic_list_covenant_values`

Retrieve covenant values based on query filters.

List Deliverables`lumonic_list_deliverables`

Retrieve the recurring reporting obligations entities owe you, and the cadence of each.

List Tasks`lumonic_list_tasks`

Retrieve a list of tasks and their derived status based on query filters.

Get A Document`lumonic_get_document`

Retrieve details of a specific document by its unique ID.

List Documents`lumonic_list_documents`

Retrieve a list of documents based on query filters.

Create Document Upload Targets`lumonic_create_document_uploads`

Create pre-signed upload targets so files can be sent directly to storage, without passing through the Lumonic API.

Import Documents`lumonic_import_documents`

Create documents from files already uploaded through /document-uploads/create.

Get A Document Tag`lumonic_get_document_tag`

Retrieve details of a specific document tag by its unique ID.

List Document Tags`lumonic_list_document_tags`

Retrieve a list of document tags based on query filters.

Get An Entity`lumonic_get_entity`

Retrieve details of a specific entity by their unique ID.

List Entities`lumonic_list_entities`

Retrieve a list of all entities.

Create An Entity`lumonic_create_entity`

Create a new entity in the specified namespace.

Delete An Entity`lumonic_delete_entity`

Delete a specific entity by its unique ID.

Get A Periodic Field`lumonic_get_periodic_field`

Retrieve details of a specific periodic field by their unique ID.

List Periodic Fields`lumonic_list_periodic_fields`

Retrieve a list of periodic fields based on query filters.

List Periodic Field Values`lumonic_list_paginated_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`lumonic_import_periodic_field_values`

Bulk import periodic field values into a cluster.

Get A Static Field`lumonic_get_static_field`

Retrieve details of a specific static field by their unique ID.

List Static Fields`lumonic_list_static_fields`

Retrieve a list of static fields based on query filters.

List Static Field Values`lumonic_list_paginated_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`lumonic_import_static_field_values`

Bulk import static field values into a cluster.

Get A Formula`lumonic_get_formula`

Retrieve details of a specific formula by its unique ID, including its Lx expression in human-readable format.

List Formulas`lumonic_list_formulas`

Retrieve a list of formulas based on query filters.

List Formula Values`lumonic_list_paginated_formula_values`

Retrieve formula values based on various filter criteria such as entity IDs, effective dates, formula IDs, and scenario.

Get A Namespace`lumonic_get_namespace`

Retrieve details of a specific namespace by its unique ID.

List Namespaces`lumonic_list_namespaces`

Retrieve a list of namespaces based on query filters.

Get A Scenario`lumonic_get_scenario`

Retrieve details of a specific field\_scenario by their unique ID.

List Scenarios`lumonic_list_scenarios`

Retrieve a list of scenarios based on query filters.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.