> For the complete documentation index, see [llms.txt](https://docs.docbits.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.docbits.com/portuguese/administration-and-setup/settings/document-processing/rule-manager.md).

# Rule Manager

<figure><img src="https://4193417932-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuAz1Yhpnxw8Gd9kza0ch%2Fuploads%2Fgit-blob-bdca306615d93d33e45d5f5981196194eb14de89%2Frule_management.png?alt=media" alt="Rule Management"><figcaption><p>Página Rule Management</p></figcaption></figure>

O Rule Management permite criar e gerenciar regras de resolução de conflitos baseadas em TOML, usadas durante o PO Matching e a exportação de documentos. Cada conjunto de regras define como o DocBits trata as divergências entre os dados da fatura e os dados do pedido de compra.

## Lista de regras

A tabela principal mostra todas as configurações de regras:

| Coluna               | Descrição                                                                                          |
| -------------------- | -------------------------------------------------------------------------------------------------- |
| **Name**             | O nome do conjunto de regras. Itens marcados como **default** são modelos fornecidos pelo sistema. |
| **Description**      | Um resumo do que o conjunto de regras trata.                                                       |
| **Last Modified By** | O usuário que editou este conjunto de regras pela última vez.                                      |
| **Last Modified At** | Data e hora da última alteração.                                                                   |
| **Actions**          | Menu de três pontos para editar, copiar ou excluir.                                                |

Clique em **+ New** para criar um novo conjunto de regras ou clique no nome de um existente para abrir o editor de regras.

***

## Referência da estrutura das regras

Esta seção apresenta uma explicação detalhada das regras de resolução de conflitos usadas no sistema de faturamento do DocBits. Essas regras foram criadas para tratar automaticamente as divergências entre os detalhes da fatura e os dados do pedido de compra (PO), garantindo uma conciliação financeira precisa. O sistema aplica essas regras para processar linhas de fatura, encargos e impostos e, quando necessário, gera os ajustes ou as notas apropriados.

## Estrutura das regras

### 1. Metadata

• version: identifica a versão do arquivo de mapeamento.

• revision: número de revisão para o controle de alterações.

• author: indica o criador do arquivo de mapeamento.

• description: uma breve descrição da finalidade do arquivo.

• created\_at & updated\_at: datas e horas de criação e da última atualização do arquivo.

### 2. Export Configuration

A seção de configuração de exportação define o mapeamento entre os campos de dados do sistema e os campos correspondentes nos arquivos de exportação.

• Header: define os campos de cabeçalho dos dados de fatura exportados.

• Tax Lines: especifica os campos dos itens de linha de imposto na exportação.

• Order Header Charges: mapeia os campos relacionados a encargos adicionais no nível do cabeçalho do pedido.

• Receipt Lines: mapeia os campos de cada item de linha de um recebimento.

• Order Line Charges: define os campos de encargos relacionados a linhas de pedido específicas.

• Cost Lines: especifica os campos das linhas de alocação de custos.

• Debit Note & Credit Note: define os campos para gerar notas de débito e de crédito em caso de divergências.

### 3. Conflict Resolution Rules

Essas regras tratam as divergências entre os dados da fatura e os dados correspondentes do pedido de compra. Cada regra é composta por vários componentes:

• Name: o nome descritivo da regra, que indica o tipo de divergência tratado.

• Section: indica a qual parte da fatura (por exemplo, receipt\_lines, line\_charges) a regra se aplica.

• Active: valor booleano (true ou false) que indica se a regra está ativa no momento.

• Match Criteria: condições que acionam a regra com base em comparações entre os dados reais da fatura e os dados esperados do pedido de compra.

• Actions: define o que o sistema deve fazer quando a regra é acionada, incluindo ajustar valores, aplicar encargos ou gerar notas de crédito/débito.

## Elementos comuns nas regras

### Operadores de comparação

Esses operadores definem como os valores reais da fatura são comparados com os valores esperados do pedido de compra:

• igual a

• maior que

• maior ou igual a

• menor que

• menor ou igual a

• dentro da tolerância

• fora da tolerância

### Status de aprovação

Indica se uma divergência foi aprovada ou não:

• aprovada

• rejeitada

• qualquer

### Tipos de ação

Define as ações específicas a executar quando uma divergência é detectada:

• linha de recebimento

• linha de custo

• encargo de cabeçalho

• encargo de linha

• linha de imposto

• linha de recebimento de nota de débito

• linha de custo de nota de débito

• encargo de cabeçalho de nota de débito

• encargo de linha de nota de débito

• linha de recebimento de nota de crédito

• linha de custo de nota de crédito

• encargo de cabeçalho de nota de crédito

• encargo de linha de nota de crédito

• linha de imposto de nota de crédito

### Exemplos de regras

#### [Casos 1, 2, 3: quantidade e preço unitário dentro da tolerância](/portuguese/administration-and-setup/settings/document-processing/rule-manager/transactionconfig-pro-template/case-1-2-3-quantity-and-unit-price-within-tolerance.md)

• Finalidade: trata cenários em que a quantidade e o preço unitário da fatura estão dentro dos limites de tolerância aceitos em comparação com o pedido de compra.

• Ação: o sistema aceita os valores da fatura e calcula o valor total.

#### [Casos 4, 5: quantidade dentro da tolerância, preço unitário fora da tolerância (aprovado)](#caso-4-5-quantidade-dentro-da-tolerancia-preco-unitario-fora-da-tolerancia-aprovado)

• Finalidade: aplica-se quando a quantidade está dentro da tolerância, mas o preço unitário está fora da tolerância e foi aprovado.

• Ação: o sistema ajusta o preço unitário para corresponder ao pedido de compra e aplica os encargos de linha necessários.

#### [Caso 6: quantidade dentro da tolerância, preço unitário fora da tolerância negativa (rejeitado)](/portuguese/administration-and-setup/settings/document-processing/rule-manager/transactionconfig-pro-template/case-6-quantity-within-tolerance-unit-price-outside-negative-tolerance-rejected.md)

• Finalidade: trata casos em que o preço unitário é menor que o esperado e está fora da faixa de tolerância, resultando em rejeição.

• Ação: o sistema ajusta o preço unitário para corresponder ao pedido de compra, gera uma nota de crédito pela diferença e aplica encargos de cabeçalho conforme necessário.

### Tratamento de encargos e impostos

### Tolerância de encargo por unidade

• As regras desta categoria tratam divergências nos encargos por unidade, com ações específicas conforme o encargo esteja dentro ou fora da tolerância e tenha sido aprovado ou rejeitado.

### Ajustes de linhas de imposto

• Essas regras gerenciam divergências de impostos, ajustando as linhas de imposto ou gerando as notas de crédito ou débito correspondentes com base nas diferenças entre os dados de imposto da fatura e do pedido de compra.

### Enums e opções

• Enums: listas predefinidas de valores que garantem consistência entre as regras (por exemplo, operadores de comparação, tipos de aprovação).

• Opções: escolhas predefinidas para o tratamento de quantidades ou preços unitários, que oferecem flexibilidade na definição das regras.

## Explicação das capturas de tela

### Captura de tela 1: interface do Rule Management

<figure><img src="https://4193417932-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuAz1Yhpnxw8Gd9kza0ch%2Fuploads%2Fgit-blob-1d2dd9e4027df8807c577f9250e13c25fcb1ceff%2Frule_management_interface.png?alt=media" alt="Interface do Rule Management"><figcaption></figcaption></figure>

Esta captura de tela mostra a interface do Rule Management, na qual os administradores podem visualizar e gerenciar todas as regras de resolução de conflitos. Os principais elementos incluem:

• Botão Add Rule: permite adicionar novas regras.

• Lista de regras: exibe todas as regras ativas com detalhes como nome, seção e status de ativação.

• Lista suspensa Section: filtra as regras com base na seção à qual se aplicam (por exemplo, Receipt Lines, Line Charges).

### Captura de tela 2: edição detalhada de regras

<figure><img src="https://4193417932-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FuAz1Yhpnxw8Gd9kza0ch%2Fuploads%2Fgit-blob-bb5a84f82f3f82fae8c6a1ba436c5f44e3b29cb4%2Frule_detailed_editing.png?alt=media" alt="Edição detalhada de regras"><figcaption></figcaption></figure>

Esta captura de tela ilustra a visualização detalhada de uma regra específica em edição. Os principais elementos incluem:

• Seção Criteria: define as condições em que a regra é acionada. Por exemplo, os critérios podem especificar que, se a quantidade e o preço unitário diferirem do pedido de compra, mas estiverem dentro da tolerância, a regra deve ser aplicada.

• Seção Actions: especifica as ações que devem ser executadas quando os critérios são atendidos. Isso pode incluir ajustar as linhas da fatura, gerar notas de crédito ou débito ou aplicar encargos adicionais.

• Document Type e Costing Elements: permite que o administrador associe ações específicas a tipos de documento e elementos de custo, oferecendo flexibilidade para tratar diferentes cenários.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.docbits.com/portuguese/administration-and-setup/settings/document-processing/rule-manager.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
