Esquemas personalizados

Quando você precisa ler algo de um documento que não está nos esquemas do sistema, defina seu próprio.

Quando faz sentido

• Documento de um fornecedor com layout não padrão.
• Especialidade da indústria: bilhetes de pesagem, relatórios de teste, cartões de combustível.
• Campos que você precisa para seu sistema e não aparecem em nenhum outro lugar.

Tenha em mente que documentos de esquemas personalizados não podem ser enviados para a contabilidade nem exportados para formatos contábeis — esses leem campos fixos da fatura. Permanece JSON, XML, YAML, CSV, Excel e PDF. Relatórios consideram apenas documentos que têm o campo numérico TotalAmount.

Como é definido

Pelo editor na aba Esquemas. É escrito em JSON Schema — objeto com properties, cada campo com type e description, listas como array com items. Quem conhece o padrão não ficará surpreso; quem não conhece, começará a partir de um modelo (fatura, fatura com IVA, recibo, nota de entrega, mínima) ou de uma cópia do esquema do sistema.

Links, allOf, oneOf, condições e construções semelhantes não são permitidos pelo editor; o esquema deve ser uma árvore plana de campos. A cópia do esquema do sistema traz também sua definição para o modelo, reconhecendo assim tão bem quanto o modelo; com o botão Desvincular torna-se um esquema personalizado comum.

A descrição do campo é um guia para o modelo

Esta é a parte mais importante de toda a página. A description não serve apenas para o humano, o modelo também a lê. A diferença entre “número do pedido" e “número do pedido, começa com Z- e tem seis dígitos, geralmente no canto superior direito junto ao código de barras” é enorme em termos de sucesso.

Limites

O número de campos é determinado pelo plano: 80 no Free e Starter, 160 no Business, 240 no Scale. Campos aninhados e campos de itens também são contabilizados. Nomes e descrições são enviados ao modelo para cada documento, portanto, um esquema mais longo significa processamento mais caro.

Testando

O editor verifica a sintaxe continuamente e não permitirá salvar até que o esquema esteja correto. Testá-lo só é possível em um documento real: faça o upload com o esquema selecionado ou, em um documento finalizado, escolha Processar novamente. Ambos consomem créditos como o processamento normal.

Alterações e exclusões

O esquema modificado se aplica a futuros processamentos. Documentos que já passaram mantêm os dados como foram gerados. Um esquema, pelo qual pelo menos um documento foi reconhecido, não pode ser excluído — os documentos perderiam o formulário de controle.