Lerian

https://docs.lerian.studio/
Admin
Lerian is a source-available financial infrastructure platform providing core banking,...
Tokens:53,944
Snippets:765
Trust Score:6.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start a connection extraction

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create an extraction request for a discovered connection and submit it to Fetcher for the authenticated tenant.

```APIDOC
## Start a connection extraction

### Description
Use this endpoint to create an extraction request for a discovered connection and submit it to Fetcher for the authenticated tenant.

### Method
POST

### Endpoint
/reference/matcher/create-extraction
```

--------------------------------

### Initiate a Pix Transfer

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to start a Pix cash-out by creating an initiation record. This endpoint retrieves and validates destination information without moving funds.

```APIDOC
## POST /reference/midaz/plugins/indirect-pix/initiate-transfer

### Description
Initiates a Pix cash-out by creating an initiation record, validating destination information without moving funds.

### Method
POST

### Endpoint
/reference/midaz/plugins/indirect-pix/initiate-transfer

### Parameters
#### Request Body
- **destination_account** (string) - Required - The account details for the transfer destination.
- **amount** (number) - Required - The amount to be transferred.
- **description** (string) - Optional - A description for the transfer.

### Response
#### Success Response (200)
- **initiation_id** (string) - The unique identifier for the transfer initiation.
- **status** (string) - The status of the transfer initiation.
```

--------------------------------

### Request an Access Token

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to get an access token for a user or client.

```APIDOC
## Request an Access Token

### Description
Obtains an access token for a user or client.

### Method
POST

### Endpoint
/oauth/token

### Request Body
- **grant_type** (string) - Required - The grant type (e.g., `password`, `client_credentials`).
- **username** (string) - Optional - The username for password grant.
- **password** (string) - Optional - The password for password grant.
- **client_id** (string) - Optional - The client ID for client credentials grant.
- **client_secret** (string) - Optional - The client secret for client credentials grant.
```

--------------------------------

### Execute a Workflow

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to start a new workflow execution. The request returns immediately with a `pending` status. Use the Idempotency-Key header to ensure safe retries.

```APIDOC
## Execute a Workflow

### Description
Starts a new workflow execution. The request returns immediately with a `pending` status. Use the Idempotency-Key header to ensure safe retries.

### Method
POST

### Endpoint
/workflows/{workflowId}/execute

### Headers
- **Idempotency-Key** (string) - Required - Ensures safe retries.
```

--------------------------------

### Get Fetcher Bridge Readiness Summary

Source: https://docs.lerian.studio/llms.txt

Returns aggregate counts of Fetcher extractions partitioned by bridge readiness state (pending, ready, stale, failed, in_flight) for the requesting tenant. Powers the operational dashboard backlog widget.

```APIDOC
## GET /reference/matcher/get-bridge-readiness-summary

### Description
Returns aggregate counts of Fetcher extractions partitioned by bridge readiness state.

### Method
GET

### Endpoint
/reference/matcher/get-bridge-readiness-summary

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "request body not specified"
}
```

### Response
#### Success Response (200)
None explicitly defined in source.

#### Response Example
```json
{
  "example": "response body not specified"
}
```
```

--------------------------------

### Create a Limit

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a spending limit with scopes array. Limits are created in DRAFT status. Use the activate endpoint to start enforcement. After creation, limitType and currency cannot be changed.

```APIDOC
## Create a Limit

### Description
Use this endpoint to create a spending limit with scopes array. Limits are created in DRAFT status. Use the activate endpoint to start enforcement. After creation, limitType and currency cannot be changed.

### Method
POST

### Endpoint
`/tracer/limits`

### Parameters
#### Request Body
- **limitType** (string) - Required - The type of the limit.
- **currency** (string) - Required - The currency for the limit.
- **amount** (number) - Required - The amount of the limit.
- **scopes** (array) - Required - An array of scopes for the limit.
```

--------------------------------

### Get a Catalog Provider

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog provider.

```APIDOC
## Get a Catalog Provider

### Description
Retrieves the metadata and JSON Schema of a specific catalog provider.

### Method
GET

### Endpoint
/catalog/providers/{providerId}
```

--------------------------------

### Create a Rule

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a validation rule with a CEL expression and scopes array. Rules are always created in DRAFT status. Use the activate endpoint to start evaluation.

```APIDOC
## Create a Rule

### Description
Use this endpoint to create a validation rule with a CEL expression and scopes array. Rules are always created in DRAFT status. Use the activate endpoint to start evaluation.

### Method
POST

### Endpoint
`/tracer/rules`

### Parameters
#### Request Body
- **expression** (string) - Required - The CEL expression for the rule.
- **scopes** (array) - Required - An array of scopes for the rule.
```

--------------------------------

### Create a Portfolio

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a Portfolio.

```APIDOC
## Create a Portfolio

### Description
Use this endpoint to create a Portfolio.

### Method
POST

### Endpoint
/midaz/portfolios

### Request Body
- **name** (string) - Required - The name of the portfolio.
- **description** (string) - Optional - A description for the portfolio.
```

--------------------------------

### Get Schedule

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve a specific reconciliation schedule by its identifier.

```APIDOC
## Get Schedule

### Description
Retrieves a specific reconciliation schedule by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-schedule/{scheduleId}

### Parameters
#### Path Parameters
- **scheduleId** (string) - Required - The unique identifier of the schedule.

### Response
#### Success Response (200)
- **schedule** (object) - Details of the reconciliation schedule.
```

--------------------------------

### Get Exception

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific exception by its identifier.

```APIDOC
## Get Exception

### Description
Retrieves the details of a specific exception by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-exception/{exceptionId}

### Parameters
#### Path Parameters
- **exceptionId** (string) - Required - The unique identifier of the exception.

### Response
#### Success Response (200)
- **exception** (object) - Details of the exception.
```

--------------------------------

### Readiness check

Source: https://docs.lerian.studio/llms.txt

Check if the service is ready to accept traffic by verifying all dependencies (database connection). This endpoint does not require authentication and is designed for Kubernetes readiness probes.

```APIDOC
## Readiness check

### Description
Check if the service is ready to accept traffic by verifying all dependencies (database connection). This endpoint does not require authentication and is designed for Kubernetes readiness probes.

### Method
GET

### Endpoint
`/tracer/ready`
```

--------------------------------

### Get service version

Source: https://docs.lerian.studio/llms.txt

Returns the current version of the service. This endpoint does not require authentication.

```APIDOC
## Get service version

### Description
Returns the current version of the service. This endpoint does not require authentication.

### Method
GET

### Endpoint
`/tracer/version`
```

--------------------------------

### Create a Ledger

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a Ledger.

```APIDOC
## Create a Ledger

### Description
Use this endpoint to create a Ledger.

### Method
POST

### Endpoint
/midaz/ledgers

### Request Body
- **name** (string) - Required - The name of the ledger.
- **description** (string) - Optional - A description for the ledger.
```

--------------------------------

### Get a Workflow

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve a specific workflow definition by its unique identifier.

```APIDOC
## Get a Workflow

### Description
Retrieves a specific workflow definition by its unique identifier.

### Method
GET

### Endpoint
/workflows/{workflowId}
```

--------------------------------

### Create a Package

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create packages along with their associated fees in a single request.

```APIDOC
## POST /packages

### Description
Use this endpoint to create packages along with their associated fees in a single request.

### Method
POST

### Endpoint
/packages

### Request Body
- **package_details** (object) - Required - Details of the package to be created
- **fees** (array) - Optional - Associated fees for the package
```

--------------------------------

### Get dashboard summary

Source: https://docs.lerian.studio/llms.txt

Returns aggregated transfer counters and operational health snapshot for dashboards.

```APIDOC
## Get dashboard summary

### Description
Returns aggregated transfer counters and operational health snapshot for dashboards.

### Method
GET

### Endpoint
/midaz/plugins/ted/get-dashboard-summary
```

--------------------------------

### Create a Static QR Code

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a static Pix BR Code that can be reused for multiple payments.

```APIDOC
## POST /reference/midaz/plugins/indirect-pix/create-static-qr-code

### Description
Creates a static Pix BR Code that can be reused for multiple payments.

### Method
POST

### Endpoint
/reference/midaz/plugins/indirect-pix/create-static-qr-code

### Parameters
#### Request Body
- **payment_details** (object) - Required - Details of the payment (e.g., amount, description).
- **expiration_date** (string) - Optional - The expiration date for the QR code.

### Response
#### Success Response (200)
- **qr_code_id** (string) - The unique identifier for the static QR code.
- **qr_code_data** (string) - The data payload for the QR code.
```

--------------------------------

### Create an Application

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create the credentials that an external application will use to integrate with Lerian's application. Ideal for registering applications that need to interact with the plugin (M2M).

```APIDOC
## Create an Application

### Description
Creates credentials for an external application to integrate with Lerian.

### Method
POST

### Endpoint
/applications

### Request Body
- **name** (string) - Required - The name of the application.
- **description** (string) - Optional - A description for the application.
```

--------------------------------

### Get Reconciliation Source

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific reconciliation source by its identifier.

```APIDOC
## Get Reconciliation Source

### Description
Retrieves the details of a specific reconciliation source by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-source/{sourceId}

### Parameters
#### Path Parameters
- **sourceId** (string) - Required - The unique identifier of the reconciliation source.

### Response
#### Success Response (200)
- **source** (object) - Details of the reconciliation source.
```

--------------------------------

### List Applications

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to list all applications that you have created to connect with Lerian's application using M2M credentials—based on the identity provider settings you configured.

```APIDOC
## List Applications

### Description
Lists all applications created for M2M integration with Lerian.

### Method
GET

### Endpoint
/applications
```

--------------------------------

### Get Match Rule

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific match rule by its identifier.

```APIDOC
## Get Match Rule

### Description
Retrieves the details of a specific match rule by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-match-rule/{ruleId}

### Parameters
#### Path Parameters
- **ruleId** (string) - Required - The unique identifier of the match rule.

### Response
#### Success Response (200)
- **matchRule** (object) - Details of the match rule.
```

--------------------------------

### Get Fee Schedule

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific fee schedule by its identifier.

```APIDOC
## Get Fee Schedule

### Description
Retrieves the details of a specific fee schedule by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-fee-schedule/{feeScheduleId}

### Parameters
#### Path Parameters
- **feeScheduleId** (string) - Required - The unique identifier of the fee schedule.

### Response
#### Success Response (200)
- **feeSchedule** (object) - Details of the fee schedule.
```

--------------------------------

### Get Fee Rule

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific fee rule by its identifier.

```APIDOC
## Get Fee Rule

### Description
Retrieves the details of a specific fee rule by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-fee-rule/{feeRuleId}

### Parameters
#### Path Parameters
- **feeRuleId** (string) - Required - The unique identifier of the fee rule.

### Response
#### Success Response (200)
- **feeRule** (object) - Details of the fee rule.
```

--------------------------------

### Create an Entry

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a new Pix entry associated with an account and its data.

```APIDOC
## POST /reference/midaz/plugins/indirect-pix/create-entry

### Description
Creates a new Pix entry associated with an account and its data.

### Method
POST

### Endpoint
/reference/midaz/plugins/indirect-pix/create-entry

### Parameters
#### Request Body
- **account_id** (string) - Required - The ID of the account.
- **entry_data** (object) - Required - Data associated with the Pix entry.

### Response
#### Success Response (200)
- **entry_id** (string) - The unique identifier for the created entry.
- **status** (string) - The status of the entry creation.
```

--------------------------------

### List Balances

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to list all balances.

```APIDOC
## List Balances

### Description
Lists all available balances.

### Method
GET

### Endpoint
`/midaz/balances`

### Response
#### Success Response (200)
- **balances** (array) - A list of balance objects.
```

--------------------------------

### Get Extraction Request

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific extraction request by its identifier.

```APIDOC
## Get Extraction Request

### Description
Retrieves the details of a specific extraction request by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-extraction/{extractionId}

### Parameters
#### Path Parameters
- **extractionId** (string) - Required - The unique identifier of the extraction request.

### Response
#### Success Response (200)
- **extraction** (object) - Details of the extraction request.
```

--------------------------------

### Get Export Job Status

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the status of a specific export job.

```APIDOC
## Get Export Job Status

### Description
Retrieves the status of a specific export job.

### Method
GET

### Endpoint
/reference/matcher/retrieve-export-job/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The unique identifier of the export job.

### Response
#### Success Response (200)
- **jobStatus** (object) - The status and details of the export job.
```

--------------------------------

### Create a Report

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to generate reports asynchronously using pre-registered templates. You can apply custom filters to define specific criteria by domain, like account IDs in onboarding.

```APIDOC
## POST /reports

### Description
Generates reports asynchronously using pre-registered templates with optional custom filters.

### Method
POST

### Endpoint
/reports

### Parameters
#### Request Body
- **templateId** (string) - Required - The identifier of the report template to use.
- **filters** (object) - Optional - Custom filters to apply to the report generation.
```

--------------------------------

### Create a Balance

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to add new balances to an account.

```APIDOC
## Create a Balance

### Description
Use this endpoint to add new balances to an account.

### Method
POST

### Endpoint
/midaz/accounts/{account_id}/balances

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The identifier of the account to add the balance to.

### Request Body
- **amount** (number) - Required - The amount of the balance.
- **currency** (string) - Required - The currency of the balance.
```

--------------------------------

### Get Reconciliation Context

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific reconciliation context by its identifier.

```APIDOC
## Get Reconciliation Context

### Description
Retrieves the details of a specific reconciliation context by its identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-context/{contextId}

### Parameters
#### Path Parameters
- **contextId** (string) - Required - The unique identifier of the reconciliation context.

### Response
#### Success Response (200)
- **context** (object) - Details of the reconciliation context.
```

--------------------------------

### Check service readiness

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to check whether the service is ready to accept traffic by verifying all required dependencies (database, cache, MongoDB, and telemetry). This endpoint is designed for Kubernetes readiness probes.

```APIDOC
## Check service readiness

### Description
Checks whether the service is ready to accept traffic by verifying all required dependencies (database, cache, MongoDB, and telemetry). Designed for Kubernetes readiness probes.

### Method
GET

### Endpoint
/midaz/plugins/ted/check-readiness
```

--------------------------------

### Get Connection Schema

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve all discovered table schemas for a specific connection.

```APIDOC
## GET /reference/matcher/get-connection-schema

### Description
Retrieves all discovered table schemas for a specific connection.

### Method
GET

### Endpoint
/reference/matcher/get-connection-schema

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "request body not specified"
}
```

### Response
#### Success Response (200)
None explicitly defined in source.

#### Response Example
```json
{
  "example": "response body not specified"
}
```
```

--------------------------------

### List Fetcher bridge readiness candidates

Source: https://docs.lerian.studio/llms.txt

Returns extractions in the requested readiness state with cursor pagination. Drilldown surface for the operational dashboard summary.

```APIDOC
## GET /matcher/bridge-candidates

### Description
Returns extractions in the requested readiness state with cursor pagination. Drilldown surface for the operational dashboard summary.

### Method
GET

### Endpoint
/matcher/bridge-candidates
```

--------------------------------

### Get a Provider Configuration

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve a specific provider configuration by its unique identifier.

```APIDOC
## Get a Provider Configuration

### Description
Retrieves a specific provider configuration by its unique identifier.

### Method
GET

### Endpoint
/provider-configurations/{providerConfigId}
```

--------------------------------

### Create a User

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a user access and assign it to a permission group in a single step.

```APIDOC
## Create a User

### Description
Creates a user and assigns them to a permission group.

### Method
POST

### Endpoint
/users

### Request Body
- **username** (string) - Required - The username for the new user.
- **email** (string) - Required - The email address of the user.
- **group_id** (string) - Required - The ID of the permission group to assign the user to.
```

--------------------------------

### Get an Executor Configuration

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve a specific executor configuration by its unique identifier.

```APIDOC
## Get an Executor Configuration

### Description
Retrieves a specific executor configuration by its unique identifier.

### Method
GET

### Endpoint
/executor-configurations/{executorConfigId}
```

--------------------------------

### Get an Execution Status

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the current status of a specific workflow execution.

```APIDOC
## Get an Execution Status

### Description
Retrieves the current status of a specific workflow execution.

### Method
GET

### Endpoint
/executions/{executionId}/status
```

--------------------------------

### List Packages

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve all registered packages along with their associated fees.

```APIDOC
## GET /packages

### Description
Use this endpoint to retrieve all registered packages along with their associated fees.

### Method
GET

### Endpoint
/packages
```

--------------------------------

### Get Audit Event by ID

Source: https://docs.lerian.studio/llms.txt

Retrieve a single audit event by its unique event ID.

```APIDOC
## Get Audit Event by ID

### Description
Retrieves a single audit event by its unique event ID.

### Method
GET

### Endpoint
/audit-events/{eventId}
```

--------------------------------

### Create an Asset

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create an Asset that will be used with the transactions. You can create multiple Assets, but they must be created one at a time, with each Asset requiring specific decimal place settings and other individual parameters to be defined during the creation process.

```APIDOC
## POST /assets

### Description
Creates a new asset for use in transactions. Each asset requires specific decimal place settings and other parameters during creation.

### Method
POST

### Endpoint
/assets

### Request Body
- **decimal_places** (integer) - Required - The number of decimal places for the asset.
- **name** (string) - Required - The name of the asset.
- **symbol** (string) - Required - The symbol of the asset.

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the created asset.
- **decimal_places** (integer) - The number of decimal places for the asset.
- **name** (string) - The name of the asset.
- **symbol** (string) - The symbol of the asset.
- **createdAt** (string) - The timestamp when the asset was created.
```

--------------------------------

### Get Discovered Connection

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve a single discovered Fetcher connection by its internal identifier.

```APIDOC
## Get Discovered Connection

### Description
Retrieves a single discovered Fetcher connection by its internal identifier.

### Method
GET

### Endpoint
/reference/matcher/retrieve-discovery-connection/{connectionId}

### Parameters
#### Path Parameters
- **connectionId** (string) - Required - The internal identifier of the discovered connection.

### Response
#### Success Response (200)
- **connection** (object) - Details of the discovered connection.
```

--------------------------------

### Check Readiness

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to verify that the Flowker service is ready to accept traffic. Returns 200 OK when all dependencies are healthy.

```APIDOC
## Check Readiness

### Description
Verifies that the Flowker service is ready to accept traffic. Returns 200 OK when all dependencies are healthy.

### Method
GET

### Endpoint
/readiness
```

--------------------------------

### Get a Catalog Trigger

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog trigger.

```APIDOC
## Get a Catalog Trigger

### Description
Retrieves the metadata and JSON Schema of a specific catalog trigger.

### Method
GET

### Endpoint
/catalog/triggers/{triggerId}
```

--------------------------------

### Create an Account

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create an Account in Midaz. You can create as many accounts as necessary to structure your ledger, but each request creates only one account at a time.

```APIDOC
## Create an Account

### Description
Use this endpoint to create an Account in Midaz. You can create as many accounts as necessary to structure your ledger, but each request creates only one account at a time.

### Method
POST

### Endpoint
/midaz/accounts

### Request Body
- **name** (string) - Required - The name of the account.
- **account_type_id** (string) - Required - The identifier of the account type.
- **ledger_id** (string) - Required - The identifier of the ledger the account belongs to.
- **description** (string) - Optional - A description for the account.
```

--------------------------------

### Create an Account Type

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create an Account Type. You can create multiple Account Types, but they must be added one at a time.

```APIDOC
## Create an Account Type

### Description
Use this endpoint to create an Account Type. You can create multiple Account Types, but they must be added one at a time.

### Method
POST

### Endpoint
/midaz/account-types

### Request Body
- **name** (string) - Required - The name of the account type.
- **description** (string) - Optional - A description for the account type.
```

--------------------------------

### Get a Catalog Executor

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog executor.

```APIDOC
## Get a Catalog Executor

### Description
Retrieves the metadata and JSON Schema of a specific catalog executor.

### Method
GET

### Endpoint
/catalog/executors/{executorId}
```

--------------------------------

### Check Matcher Readiness

Source: https://docs.lerian.studio/llms.txt

Checks whether the Matcher service is ready to accept traffic.

```APIDOC
## GET /matcher/readiness

### Description
Use this endpoint to check whether the Matcher service is ready to accept traffic.

### Method
GET

### Endpoint
/matcher/readiness
```

--------------------------------

### Get Application Version

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the current Flowker service version and request timestamp.

```APIDOC
## Get Application Version

### Description
Retrieves the current Flowker service version and request timestamp.

### Method
GET

### Endpoint
/version
```

--------------------------------

### Create an Organization

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create an Organization. You can create multiple Organizations, but they must be added one at a time.

```APIDOC
## POST /organizations

### Description
Creates a new organization. Organizations must be created one at a time.

### Method
POST

### Endpoint
/organizations

### Request Body
- **name** (string) - Required - The name of the organization.
- **industry** (string) - Optional - The industry of the organization.

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the created organization.
- **name** (string) - The name of the organization.
- **industry** (string) - The industry of the organization.
- **createdAt** (string) - The timestamp when the organization was created.
```

--------------------------------

### Get volume statistics

Source: https://docs.lerian.studio/llms.txt

Retrieve transaction volume statistics for a reconciliation context within the specified date range.

```APIDOC
## GET /matcher/volume-stats

### Description
Use this endpoint to retrieve transaction volume statistics for a reconciliation context within the specified date range.

### Method
GET

### Endpoint
/matcher/volume-stats
```

--------------------------------

### Get SLA statistics

Source: https://docs.lerian.studio/llms.txt

Retrieve SLA compliance statistics for a reconciliation context within the specified date range.

```APIDOC
## GET /matcher/sla-stats

### Description
Use this endpoint to retrieve SLA compliance statistics for a reconciliation context within the specified date range.

### Method
GET

### Endpoint
/matcher/sla-stats
```

--------------------------------

### Get all dashboard aggregates

Source: https://docs.lerian.studio/llms.txt

Retrieve combined dashboard aggregates including volume, match rate, and SLA statistics.

```APIDOC
## GET /dashboard/aggregates

### Description
Use this endpoint to retrieve combined dashboard aggregates including volume, match rate, and SLA statistics.

### Method
GET

### Endpoint
/dashboard/aggregates
```

--------------------------------

### Preview a Transaction File

Source: https://docs.lerian.studio/llms.txt

Previews a transaction file before importing it, returning sample rows and detected columns to verify file structure and field mapping.

```APIDOC
## POST /matcher/upload/preview

### Description
Use this endpoint to preview a transaction file before importing it. Returns sample rows and detected columns to help verify the file structure and field mapping.

### Method
POST

### Endpoint
/matcher/upload/preview
```

--------------------------------

### Get Actor Mapping

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the display name and email mapped to a specific actor identifier.

```APIDOC
## GET /reference/matcher/get-actor-mapping

### Description
Retrieves the display name and email mapped to a specific actor identifier.

### Method
GET

### Endpoint
/reference/matcher/get-actor-mapping

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "request body not specified"
}
```

### Response
#### Success Response (200)
None explicitly defined in source.

#### Response Example
```json
{
  "example": "response body not specified"
}
```
```

--------------------------------

### Upload a Template

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to upload a new template to the system. It accepts a `.tpl` file that defines the structure and logic of the report. The file must be formatted according to the desired output type — HTML, XML, CSV, PDF, or TXT — using Reporter plugin blocks where applicable.

```APIDOC
## Upload a Template

### Description
Use this endpoint to upload a new template to the system. It accepts a `.tpl` file that defines the structure and logic of the report. The file must be formatted according to the desired output type — HTML, XML, CSV, PDF, or TXT — using Reporter plugin blocks where applicable.

### Method
POST

### Endpoint
`/reporter/templates`

### Parameters
#### Request Body
- **file** (file) - Required - The template file (`.tpl`) to upload.
- **description** (string) - Optional - A description for the new template.
- **outputFormat** (string) - Required - The output format of the template (e.g., HTML, XML, CSV, PDF, TXT).
```

--------------------------------

### Enable a Provider Configuration

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to enable a provider configuration. Transitions the status from `disabled` to `active`.

```APIDOC
## Enable a Provider Configuration

### Description
Enables a provider configuration. Transitions the status from `disabled` to `active`.

### Method
POST

### Endpoint
/provider-configurations/{providerConfigId}/enable
```

--------------------------------

### Retrieve User details

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to get detailed information about a specific user using their unique identifier.

```APIDOC
## Retrieve User details

### Description
Retrieves detailed information about a specific user.

### Method
GET

### Endpoint
/users/{user_id}

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The unique identifier of the user.
```

--------------------------------

### Create a connection

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a new database connection for the organization. The `configName` must be unique per organization. The password is encrypted upon creation and a UUID is automatically generated as the connection identifier.

```APIDOC
## POST /connections

### Description
Creates a new database connection for the organization.

### Method
POST

### Endpoint
/connections

### Parameters
#### Request Body
- **configName** (string) - Required - The unique name for the database connection configuration.
- **password** (string) - Required - The password for the database connection.
- **other_connection_details** (object) - Optional - Other relevant connection details.
```

--------------------------------

### Retrieve Group details

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to get detailed information about a specific group using its unique identifier.

```APIDOC
## Retrieve Group details

### Description
Retrieves detailed information about a specific group.

### Method
GET

### Endpoint
/groups/{group_id}

### Parameters
#### Path Parameters
- **group_id** (string) - Required - The unique identifier of the group.
```

--------------------------------

### Get Exception History

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the audit history for an exception. The history shows all actions taken on the exception.

```APIDOC
## Get Exception History

### Description
Retrieves the audit history for an exception. The history shows all actions taken on the exception.

### Method
GET

### Endpoint
/reference/matcher/retrieve-exception-history/{exceptionId}

### Parameters
#### Path Parameters
- **exceptionId** (string) - Required - The unique identifier of the exception.

### Response
#### Success Response (200)
- **history** (array[object]) - An array of historical actions taken on the exception.
```

--------------------------------

### Create a Provider Configuration

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a new provider configuration. The configuration is validated against the provider's JSON Schema.

```APIDOC
## Create a Provider Configuration

### Description
Creates a new provider configuration. The configuration is validated against the provider's JSON Schema.

### Method
POST

### Endpoint
/provider-configurations

### Request Body
- **providerId** (string) - Required - The ID of the provider.
- **configuration** (object) - Required - The provider configuration details.
```

--------------------------------

### Initiate a Transfer

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to initiate a transfer by validating sender data, checking operating hours and usage limits, detecting duplicates, and calculating the fee. No funds are held at this step. The returned initiationId is valid for 24 hours and must be confirmed via the Process Transfer endpoint.

```APIDOC
## Initiate a Transfer

### Description
Initiates a transfer by validating sender data, checking operating hours and usage limits, detecting duplicates, and calculating the fee. No funds are held at this step. The returned initiationId is valid for 24 hours and must be confirmed via the Process Transfer endpoint.

### Method
POST

### Endpoint
/midaz/plugins/ted/initiate-transfer
```

--------------------------------

### Get comprehensive dashboard metrics

Source: https://docs.lerian.studio/llms.txt

Retrieve complete dashboard metrics including summary, trends, and breakdowns for the Command Center.

```APIDOC
## GET /dashboard/metrics

### Description
Use this endpoint to retrieve complete dashboard metrics including summary, trends, and breakdowns for the Command Center.

### Method
GET

### Endpoint
/dashboard/metrics
```

--------------------------------

### List Users

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to list all users registered in the system.

```APIDOC
## List Users

### Description
Lists all users registered in the system.

### Method
GET

### Endpoint
/users
```

--------------------------------

### Get Execution Results

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the results of a completed workflow execution. The execution must be in a terminal state.

```APIDOC
## Get Execution Results

### Description
Retrieves the results of a completed workflow execution. The execution must be in a terminal state.

### Method
GET

### Endpoint
/executions/{executionId}/results
```

--------------------------------

### List Billing Packages

Source: https://docs.lerian.studio/llms.txt

Retrieve all billing packages for the given organization and ledger.

```APIDOC
## GET /billing-packages

### Description
Retrieve all billing packages for the given organization and ledger.

### Method
GET

### Endpoint
/billing-packages

### Query Parameters
- **organizationId** (string) - Required - The ID of the organization
- **ledgerId** (string) - Required - The ID of the ledger
```

--------------------------------

### Get Dispute

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific dispute by its identifier, including its current state, category, and any submitted evidence.

```APIDOC
## Get Dispute

### Description
Retrieves the details of a specific dispute by its identifier, including its current state, category, and any submitted evidence.

### Method
GET

### Endpoint
/reference/matcher/retrieve-dispute/{disputeId}

### Parameters
#### Path Parameters
- **disputeId** (string) - Required - The unique identifier of the dispute.

### Response
#### Success Response (200)
- **dispute** (object) - Details of the dispute.
```

--------------------------------

### Create a Claim

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a new key claim for portability or ownership. Not every type of key can be claimed or ported.

```APIDOC
## POST /reference/midaz/plugins/indirect-pix/create-claim

### Description
Creates a new key claim for portability or ownership.

### Method
POST

### Endpoint
/reference/midaz/plugins/indirect-pix/create-claim

### Parameters
#### Request Body
- **key_type** (string) - Required - The type of the Pix key.
- **key_value** (string) - Required - The value of the Pix key.
- **claim_type** (string) - Required - The type of claim (e.g., portability, ownership).

### Response
#### Success Response (200)
- **claim_id** (string) - The unique identifier for the created claim.
- **status** (string) - The status of the claim.
```

--------------------------------

### Get match rate statistics

Source: https://docs.lerian.studio/llms.txt

Retrieve match rate percentage and trend data for a reconciliation context within the specified date range.

```APIDOC
## GET /matcher/match-rate-stats

### Description
Use this endpoint to retrieve match rate percentage and trend data for a reconciliation context within the specified date range.

### Method
GET

### Endpoint
/matcher/match-rate-stats
```

--------------------------------

### List Templates

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to list all templates available in the system. You can apply filters, pagination, and sorting to narrow down results and find specific templates based on your criteria.

```APIDOC
## List Templates

### Description
Use this endpoint to list all templates available in the system. You can apply filters, pagination, and sorting to narrow down results and find specific templates based on your criteria.

### Method
GET

### Endpoint
`/reporter/templates`

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter criteria for templates.
- **page** (integer) - Optional - Page number for pagination.
- **sort** (string) - Optional - Sorting criteria for templates.
```

--------------------------------

### Create a schedule

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a cron-based reconciliation schedule for automatic matching within a context.

```APIDOC
## Create a schedule

### Description
Use this endpoint to create a cron-based reconciliation schedule for automatic matching within a context.

### Method
POST

### Endpoint
/reference/matcher/create-schedule
```

--------------------------------

### Get Match Run

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific match run by its identifier. The response includes status, timing, and aggregate statistics.

```APIDOC
## Get Match Run

### Description
Retrieves the details of a specific match run by its identifier. The response includes status, timing, and aggregate statistics.

### Method
GET

### Endpoint
/reference/matcher/retrieve-match-run/{matchRunId}

### Parameters
#### Path Parameters
- **matchRunId** (string) - Required - The unique identifier of the match run.

### Response
#### Success Response (200)
- **matchRun** (object) - Details of the match run.
```

--------------------------------

### Create a manual match

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to manually link multiple transactions (at least 2) into a match group with 100% confidence. Transactions must be UNMATCHED and belong to the specified context.

```APIDOC
## Create a manual match

### Description
Use this endpoint to manually link multiple transactions (at least 2) into a match group with 100% confidence. Transactions must be UNMATCHED and belong to the specified context.

### Method
POST

### Endpoint
/reference/matcher/create-manual-match
```

--------------------------------

### Get reconciliation summary report

Source: https://docs.lerian.studio/llms.txt

Retrieve an aggregated reconciliation summary for a specific context and date range, including matched and unmatched counts and amounts.

```APIDOC
## GET /matcher/summary-report

### Description
Use this endpoint to retrieve an aggregated reconciliation summary for a specific context and date range, including matched and unmatched counts and amounts.

### Method
GET

### Endpoint
/matcher/summary-report
```

--------------------------------

### Get Discovery Status

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the current Fetcher integration status, including whether the Fetcher service is healthy and how many connections have been discovered.

```APIDOC
## GET /reference/matcher/discovery-status

### Description
Retrieves the current Fetcher integration status, including service health and discovered connections.

### Method
GET

### Endpoint
/reference/matcher/discovery-status

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "request body not specified"
}
```

### Response
#### Success Response (200)
None explicitly defined in source.

#### Response Example
```json
{
  "example": "response body not specified"
}
```
```

--------------------------------

### List Assets

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of all Assets in your Ledger.

```APIDOC
## List Assets

### Description
Retrieves details of all Assets in your Ledger.

### Method
GET

### Endpoint
`/midaz/assets`

### Response
#### Success Response (200)
- **assets** (array) - A list of asset objects.
```

--------------------------------

### Get Ingestion Job Status

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the status and details of a specific ingestion job by its identifier. The response includes progress metrics and error information.

```APIDOC
## Get Ingestion Job Status

### Description
Retrieves the status and details of a specific ingestion job by its identifier. The response includes progress metrics and error information.

### Method
GET

### Endpoint
/reference/matcher/retrieve-ingestion-job/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The unique identifier of the ingestion job.

### Response
#### Success Response (200)
- **jobStatus** (object) - The status and details of the ingestion job.
```

--------------------------------

### List Fee Schedules

Source: https://docs.lerian.studio/llms.txt

Retrieves all fee schedules for the authenticated tenant.

```APIDOC
## GET /matcher/fee-schedules

### Description
Use this endpoint to retrieve all fee schedules for the authenticated tenant.

### Method
GET

### Endpoint
/matcher/fee-schedules
```

--------------------------------

### List discovered connections

Source: https://docs.lerian.studio/llms.txt

Retrieve all discovered Fetcher database connections available for the current tenant.

```APIDOC
## GET /matcher/discovery-connections

### Description
Use this endpoint to retrieve all discovered Fetcher database connections available for the current tenant.

### Method
GET

### Endpoint
/matcher/discovery-connections
```

--------------------------------

### Get Match Run Results

Source: https://docs.lerian.studio/llms.txt

Retrieves all match groups from a specific matching run. Each group contains matched transaction pairs and confidence scores. Uses cursor-based pagination.

```APIDOC
## GET /matcher/match-runs/{run_id}/groups

### Description
Use this endpoint to retrieve all match groups from a specific matching run. Each group contains matched transaction pairs and confidence scores. The response uses cursor-based pagination.

### Method
GET

### Endpoint
/matcher/match-runs/{run_id}/groups
```

--------------------------------

### Create a fee rule

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a new fee rule that maps transaction metadata to a fee schedule within a context.

```APIDOC
## Create a fee rule

### Description
Use this endpoint to create a new fee rule that maps transaction metadata to a fee schedule within a context.

### Method
POST

### Endpoint
/reference/matcher/create-fee-rule
```

--------------------------------

### List Entries

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to list all Pix entries for an account with optional filters. Returns an empty array [] if no entries match the criteria.

```APIDOC
## GET /reference/midaz/plugins/indirect-pix/list-entries

### Description
Lists all Pix entries for an account with optional filters.

### Method
GET

### Endpoint
/reference/midaz/plugins/indirect-pix/list-entries

### Parameters
#### Query Parameters
- **account_id** (string) - Required - The ID of the account.
- **filter** (string) - Optional - Filters to apply to the entries list.

### Response
#### Success Response (200)
- **entries** (array) - A list of Pix entries matching the criteria.
```

--------------------------------

### Get Field Map by Source

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the field map for a specific source within a context. Field maps define how source fields are mapped to reconciliation fields.

```APIDOC
## Get Field Map by Source

### Description
Retrieves the field map for a specific source within a context. Field maps define how source fields are mapped to reconciliation fields.

### Method
GET

### Endpoint
/reference/matcher/retrieve-field-map-by-source/{contextId}/{sourceId}

### Parameters
#### Path Parameters
- **contextId** (string) - Required - The unique identifier of the reconciliation context.
- **sourceId** (string) - Required - The unique identifier of the source.

### Response
#### Success Response (200)
- **fieldMap** (object) - The field map configuration.
```

--------------------------------

### Get source breakdown

Source: https://docs.lerian.studio/llms.txt

Retrieve a breakdown of reconciliation metrics by source for a specific context and date range. Shows match rates, transaction counts, and unmatched amounts per source.

```APIDOC
## GET /matcher/source-breakdown

### Description
Use this endpoint to retrieve a breakdown of reconciliation metrics by source for a specific context and date range. Shows match rates, transaction counts, and unmatched amounts per source.

### Method
GET

### Endpoint
/matcher/source-breakdown
```

--------------------------------

### List Groups

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to list all predefined groups available in the system.

```APIDOC
## List Groups

### Description
Lists all predefined groups available in the system.

### Method
GET

### Endpoint
/groups
```

--------------------------------

### Create a Transaction using DSL

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to create a transaction using a DSL file you have previously created.

```APIDOC
## Create a Transaction using DSL

### Description
Use this endpoint to create a transaction using a DSL file you have previously created.

### Method
POST

### Endpoint
/midaz/transactions/dsl

### Request Body
- **dsl_file_id** (string) - Required - The identifier of the DSL file to use.
- **parameters** (object) - Optional - Parameters to be used with the DSL file.
```

--------------------------------

### Service version

Source: https://docs.lerian.studio/llms.txt

Returns the service version from the VERSION environment variable (defaults to "0.0.0").

```APIDOC
## GET /version

### Description
Returns the service version from the VERSION environment variable (defaults to "0.0.0").

### Method
GET

### Endpoint
/version
```

--------------------------------

### Get a Transfer

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the current status and details of a transfer, including its type, status history, sender and recipient details, amounts, and timestamps. Only returns transfers belonging to the same organization.

```APIDOC
## Get a Transfer

### Description
Retrieves the current status and details of a transfer, including its type, status history, sender and recipient details, amounts, and timestamps. Only returns transfers belonging to the same organization.

### Method
GET

### Endpoint
/midaz/plugins/ted/retrieve-transfer
```

--------------------------------

### List Data Sources

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve a complete list of data sources connected to the plugin, including all information stored in the database.

```APIDOC
## List Data Sources

### Description
Use this endpoint to retrieve a complete list of data sources connected to the plugin, including all information stored in the database.

### Method
GET

### Endpoint
`/reporter/data-sources`
```

--------------------------------

### Get Audit Log by ID

Source: https://docs.lerian.studio/llms.txt

Use this endpoint to retrieve the details of a specific audit log entry by its identifier. Audit logs contain immutable records of all system operations for compliance and debugging purposes.

```APIDOC
## Get Audit Log by ID

### Description
Retrieves the details of a specific audit log entry by its identifier. Audit logs contain immutable records of all system operations for compliance and debugging purposes.

### Method
GET

### Endpoint
/reference/matcher/retrieve-audit-log/{auditLogId}

### Parameters
#### Path Parameters
- **auditLogId** (string) - Required - The unique identifier of the audit log entry.

### Response
#### Success Response (200)
- **logEntry** (object) - Details of the audit log entry.
```
Tokens:
Raw