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

# Workflows & Reporting

> Reference the workflow and reporting fields used by Flowker, Reporter, Fees Engine, and shared error-handling structures.

This page brings together all fields used by Flowker, Reporter, Fees Engine, and error-handling structures.

## 1. Reporting (Reporter)

***

| Field        | Description                      | Used in  |
| ------------ | -------------------------------- | -------- |
| templateName | Name of the template             | Reporter |
| templateType | Template type (PDF, HTML, Excel) | Reporter |
| dataSource   | Data source for template         | Reporter |
| parameters   | Parameters for generation        | Reporter |
| outputFormat | Output format                    | Reporter |
| reportId     | Generated report ID              | Reporter |

## 2. Workflow orchestration (Flowker general)

***

| Field          | Description          | Used in |
| -------------- | -------------------- | ------- |
| workflowName   | Workflow name        | Flowker |
| workflow       | Workflow filter      | Flowker |
| workflow\_type | Workflow type        | Flowker |
| stepId         | Step identifier      | Flowker |
| stepType       | Step type            | Flowker |
| conditions     | Execution conditions | Flowker |
| actions        | Actions to execute   | Flowker |
| variables      | Context variables    | Flowker |
| dependencies   | Step dependencies    | Flowker |

## 3. Fees Engine

***

| Field            | Description               | Used in |
| ---------------- | ------------------------- | ------- |
| feeGroupLabel    | Fee group label           | Fee     |
| feeLabel         | Specific fee label        | Fee     |
| calculationModel | Fee calculation model     | Fee     |
| applicationRule  | Application rule          | Fee     |
| calculations     | Fee calculation array     | Fee     |
| referenceAmount  | Reference amount          | Fee     |
| priority         | Fee priority              | Fee     |
| isDeductibleFrom | Whether fee is deductible | Fee     |
| creditAccount    | Fee credit account        | Fee     |
| routeFrom        | Origin route              | Fee     |
| routeTo          | Destination route         | Fee     |
| transactionRoute | Transaction route         | Fee     |
| enable           | Fee enabled flag          | Fee     |

## 4. Error handling

***

| Field      | Description                 | Used in                |
| ---------- | --------------------------- | ---------------------- |
| error      | Error code                  | Pix, Fee, CRM          |
| message    | Error message               | Pix, Fee, CRM, Flowker |
| details    | Specific error details      | Pix, Fee               |
| field      | Field that caused the error | Pix, Fee               |
| path       | Endpoint path               | Pix                    |
| code       | Standardized error code     | Fee, CRM, Flowker      |
| entityType | Entity type                 | Fee                    |
| title      | Error title                 | Fee                    |
| timestamp  | Error timestamp             | Pix, Fee, Flowker      |

## 5. Flowker

***

Expanded fields specific to Flowker

| Field               | Description                   | Context                  |
| ------------------- | ----------------------------- | ------------------------ |
| workflowId          | Unique workflow ID            | Runtime                  |
| workflow\_id        | Workflow ID                   | Execution search         |
| runId               | Execution run ID              | Runtime                  |
| workflow\_type      | Type of workflow              | Runtime                  |
| workflow            | Workflow filter               | Event Router             |
| workflowName        | Descriptive workflow name     | Authoring                |
| providerId          | Provider ID (OAuth flow)      | OAuth2                   |
| provider\_id        | Provider ID                   | Providers                |
| provider\_ids       | List of provider IDs          | Providers                |
| batch\_id           | Batch ID                      | Providers                |
| key\_id             | API key ID                    | Admin                    |
| org\_id             | Organization ID               | Admin                    |
| template\_id        | Template ID                   | Authoring/Providers      |
| versionId           | Source version ID             | Transformations          |
| targetVersionId     | Target version ID             | Transformations          |
| ver                 | Version number                | Authoring                |
| version             | Resource version              | Providers/Authoring      |
| stepId              | Step ID                       | Authoring                |
| stepType            | Step type                     | Authoring                |
| name                | Step or resource name         | Authoring                |
| rule                | Routing rule filter           | Event Router             |
| status              | Workflow or provider status   | Multiple Flowker modules |
| state               | OAuth2 state                  | OAuth2                   |
| category            | Provider or template category | Providers                |
| tags                | Comma-separated tags          | Providers                |
| type                | Multipurpose type             | Providers/Runtime        |
| start\_date         | Start date (RFC3339)          | Analytics                |
| end\_date           | End date (RFC3339)            | Analytics                |
| start\_time\_from   | Start time (from)             | Runtime                  |
| start\_time\_to     | Start time (to)               | Runtime                  |
| period              | Period (metrics)              | Transformations          |
| limit               | Pagination limit              | Multiple endpoints       |
| offset              | Pagination offset             | Multiple endpoints       |
| page\_size          | Page size                     | Runtime                  |
| page\_token         | Pagination token              | Runtime                  |
| sort\_by            | Sort field                    | Providers/Runtime        |
| sort\_order         | Sort order                    | Providers/Runtime        |
| search              | Search term                   | Providers                |
| from                | Source version (diff)         | Authoring                |
| to                  | Target version (diff)         | Authoring                |
| code                | OAuth2 code                   | OAuth2                   |
| redirectUri         | OAuth2 redirect URI           | OAuth2                   |
| scopes              | OAuth2 scopes list            | OAuth2                   |
| X-Webhook-ID        | Webhook ID                    | Providers                |
| X-Webhook-Signature | Webhook signature             | Providers                |