> ## 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 e relatórios

> Consulte os campos de workflows e relatórios usados por Flowker, Reporter, Fees Engine e estruturas compartilhadas de tratamento de erros.

Esta página reúne todos os campos usados pelo Flowker, Reporter, Fees Engine e estruturas de tratamento de erros.

## 1. Relatórios (Reporter)

***

| Campo        | Descrição                           | Usado em |
| ------------ | ----------------------------------- | -------- |
| templateName | Nome do template                    | Reporter |
| templateType | Tipo de template (PDF, HTML, Excel) | Reporter |
| dataSource   | Fonte de dados para o template      | Reporter |
| parameters   | Parâmetros para geração             | Reporter |
| outputFormat | Formato de saída                    | Reporter |
| reportId     | ID do relatório gerado              | Reporter |

## 2. Orquestração de workflows (Flowker geral)

***

| Campo          | Descrição              | Usado em |
| -------------- | ---------------------- | -------- |
| workflowName   | Nome do workflow       | Flowker  |
| workflow       | Filtro de workflow     | Flowker  |
| workflow\_type | Tipo de workflow       | Flowker  |
| stepId         | Identificador do passo | Flowker  |
| stepType       | Tipo do passo          | Flowker  |
| conditions     | Condições de execução  | Flowker  |
| actions        | Ações a executar       | Flowker  |
| variables      | Variáveis de contexto  | Flowker  |
| dependencies   | Dependências do passo  | Flowker  |

## 3. Fees Engine

***

| Campo            | Descrição                    | Usado em |
| ---------------- | ---------------------------- | -------- |
| feeGroupLabel    | Rótulo do grupo de tarifas   | Fee      |
| feeLabel         | Rótulo da tarifa específica  | Fee      |
| calculationModel | Modelo de cálculo de tarifa  | Fee      |
| applicationRule  | Regra de aplicação           | Fee      |
| calculations     | Array de cálculos de tarifas | Fee      |
| referenceAmount  | Valor de referência          | Fee      |
| priority         | Prioridade da tarifa         | Fee      |
| isDeductibleFrom | Se a tarifa é dedutível      | Fee      |
| creditAccount    | Conta de crédito da tarifa   | Fee      |
| routeFrom        | Rota de origem               | Fee      |
| routeTo          | Rota de destino              | Fee      |
| transactionRoute | Rota da transação            | Fee      |
| enable           | Flag de tarifa habilitada    | Fee      |

## 4. Tratamento de erros

***

| Campo      | Descrição                    | Usado em               |
| ---------- | ---------------------------- | ---------------------- |
| error      | Código de erro               | PIX, Fee, CRM          |
| message    | Mensagem de erro             | PIX, Fee, CRM, Flowker |
| details    | Detalhes específicos do erro | PIX, Fee               |
| field      | Campo que causou o erro      | PIX, Fee               |
| path       | Caminho do endpoint          | PIX                    |
| code       | Código de erro padronizado   | Fee, CRM, Flowker      |
| entityType | Tipo de entidade             | Fee                    |
| title      | Título do erro               | Fee                    |
| timestamp  | Timestamp do erro            | PIX, Fee, Flowker      |

## 5. Flowker

***

Campos expandidos específicos do Flowker

| Campo               | Descrição                      | Contexto                  |
| ------------------- | ------------------------------ | ------------------------- |
| workflowId          | ID único do workflow           | Runtime                   |
| workflow\_id        | ID do workflow                 | Busca de execução         |
| runId               | ID de execução                 | Runtime                   |
| workflow\_type      | Tipo de workflow               | Runtime                   |
| workflow            | Filtro de workflow             | Event Router              |
| workflowName        | Nome descritivo do workflow    | Authoring                 |
| providerId          | ID do provider (fluxo OAuth)   | OAuth2                    |
| provider\_id        | ID do provider                 | Providers                 |
| provider\_ids       | Lista de IDs de providers      | Providers                 |
| batch\_id           | ID do lote                     | Providers                 |
| key\_id             | ID da chave API                | Admin                     |
| org\_id             | ID da organização              | Admin                     |
| template\_id        | ID do template                 | Authoring/Providers       |
| versionId           | ID da versão de origem         | Transformations           |
| targetVersionId     | ID da versão alvo              | Transformations           |
| ver                 | Número da versão               | Authoring                 |
| version             | Versão do recurso              | Providers/Authoring       |
| stepId              | ID do passo                    | Authoring                 |
| stepType            | Tipo do passo                  | Authoring                 |
| name                | Nome do passo ou recurso       | Authoring                 |
| rule                | Filtro de regra de roteamento  | Event Router              |
| status              | Status do workflow ou provider | Múltiplos módulos Flowker |
| state               | State OAuth2                   | OAuth2                    |
| category            | Categoria do provider/template | Providers                 |
| tags                | Tags separadas por vírgula     | Providers                 |
| type                | Tipo multiuso                  | Providers/Runtime         |
| start\_date         | Data de início (RFC3339)       | Analytics                 |
| end\_date           | Data de fim (RFC3339)          | Analytics                 |
| start\_time\_from   | Tempo de início (de)           | Runtime                   |
| start\_time\_to     | Tempo de início (até)          | Runtime                   |
| period              | Período (métricas)             | Transformations           |
| limit               | Limite de paginação            | Múltiplos endpoints       |
| offset              | Offset de paginação            | Múltiplos endpoints       |
| page\_size          | Tamanho da página              | Runtime                   |
| page\_token         | Token de paginação             | Runtime                   |
| sort\_by            | Campo de ordenação             | Providers/Runtime         |
| sort\_order         | Ordem de ordenação             | Providers/Runtime         |
| search              | Termo de busca                 | Providers                 |
| from                | Versão de origem (diff)        | Authoring                 |
| to                  | Versão alvo (diff)             | Authoring                 |
| code                | Código OAuth2                  | OAuth2                    |
| redirectUri         | URI de redirect OAuth2         | OAuth2                    |
| scopes              | Lista de escopos OAuth2        | OAuth2                    |
| X-Webhook-ID        | ID do webhook                  | Providers                 |
| X-Webhook-Signature | Assinatura do webhook          | Providers                 |