Esquemas personalizados

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

Quando faz sentido

• Documento de um fornecedor com layout não padrão.
• Especialidade setorial: bilhetes de pesagem, protocolos de teste, cartões de combustível.
• Campos que você precisa em seu sistema e que não aparecem em nenhum outro lugar.

Tenha em mente que um documento de esquema personalizado não pode ser enviado para a contabilidade nem exportado para formatos contábeis — eles leem campos fixos da fatura. Permanecem JSON, XML, YAML, CSV, Excel e PDF. Apenas documentos com o campo numérico TotalAmount são considerados nos resumos.

Como é definido

Com o editor na aba Esquemas. É escrito em JSON Schema — objeto com properties, para cada campo 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 do modelo (fatura, fatura com IVA, recibo, nota de entrega, mínima) ou de uma cópia do esquema do sistema. Os campos dos modelos têm nomes em inglês assim como os esquemas do sistema, portanto o formulário de controle encontrará a descrição; as descrições dos campos estão no idioma da interface e podem ser reescritas.

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 mantém também sua instrução para o modelo, portanto reconhece tão bem quanto o padrão; com o botão Desvincular, ele se torna um esquema personalizado comum.

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

Esta é a coisa mais importante da página. A description não serve apenas para o ser 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, costuma estar no canto superior direito junto ao código de barras" é enorme em termos de sucesso.

Limites

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

Testes

O editor valida a sintaxe continuamente e não permitirá a gravação até que o esquema esteja correto. Você pode testá-lo apenas em um documento real: faça o upload com o esquema selecionado ou escolha Processar novamente em um documento pronto. Ambos custam créditos como um processamento normal.

Alterações e exclusões

O esquema modificado é válido para o processamento futuro. Documentos que já passaram mantêm os dados como foram criados. Um esquema que já reconheceu pelo menos um documento não pode ser excluído — os documentos perderiam o formulário de controle.