Códigos de motivo
O motivo.codigo do recibo e da API de status, e o motivo dos webhooks, usam esta lista. Os códigos
são estáveis: podem surgir códigos novos, mas um código existente não muda de significado. Programe
sobre o código, nunca sobre o texto do detalhe, e trate um código que você não conhece como erro
genérico.
A coluna Reenvio diz o que reenviar:
- mesmo arquivo: a causa não está no arquivo; depois de resolvê-la, reenvie o mesmo arquivo;
- arquivo corrigido: o defeito está no arquivo; corrija e reenvie. O mesmo arquivo sem correção é recusado de novo pelo mesmo motivo.
O nome do arquivo no reenvio pode ser o mesmo ou outro: a deduplicação é pelo conteúdo (SHA-256).
Mais detalhes em Reenvio e idempotência.
Arquivo e envio
| Código | O que significa | O que fazer | Reenvio |
|---|---|---|---|
arquivo.vazio | o arquivo tem zero byte | envie um ZIP com conteúdo | arquivo corrigido |
arquivo.nao_e_zip | o conteúdo não é um ZIP | envie o arquivo em formato ZIP | arquivo corrigido |
arquivo.zip_excede_limite | o ZIP passa de algum limite (tamanho descompactado, taxa de compressão ou quantidade de arquivos) | divida o envio em ZIPs menores; se o lote legítimo é maior que o limite, fale com o suporte | arquivo corrigido |
arquivo.membro_nao_permitido | o ZIP contém algo além de .csv e .txt: ZIP dentro de ZIP, arquivo com senha, link ou pasta oculta | envie o ZIP só com arquivos .csv ou .txt | arquivo corrigido |
entrada.caminho_invalido | o arquivo foi gravado numa subpasta de entrada/ | envie direto em entrada/ | mesmo arquivo, gravado direto em entrada/ |
objeto.ausente | o arquivo não estava mais na entrada quando o processamento começou | reenvie o arquivo | mesmo arquivo |
objeto.mudou | o arquivo foi regravado depois do envio | reenvie e não regrave depois do envio | mesmo arquivo |
integridade.checksum_divergente | o SHA-256 informado no envio não confere com o conteúdo recebido | reenvie; se persistir, confira o SHA-256 que o seu sistema informa | mesmo arquivo |
Antivírus
| Código | O que significa | O que fazer | Reenvio |
|---|---|---|---|
antivirus.ameaca_detectada | a verificação encontrou conteúdo malicioso; o arquivo está em quarentena e não foi processado | verifique a origem do arquivo e envie um arquivo limpo | arquivo corrigido (o mesmo arquivo volta para a quarentena) |
antivirus.nao_suportado | a verificação não consegue examinar o arquivo (ZIP com senha ou compressão extrema) | envie o ZIP sem senha e sem compressão extrema | arquivo corrigido |
antivirus.indisponivel | a verificação não respondeu a tempo | reenvie mais tarde; se persistir, fale com o suporte | mesmo arquivo |
Parâmetros do lote
Os parâmetros vêm do sidecar .manifest.json, do nome do arquivo ou do padrão do espaço de trabalho
(veja Nome do arquivo e parâmetros do lote).
| Código | O que significa | O que fazer | Reenvio |
|---|---|---|---|
parametro.sidecar_invalido | o .manifest.json está ilegível, tem campo desconhecido ou valor de tipo errado; o detalhe aponta o campo | corrija o sidecar e reenvie o ZIP, sidecar primeiro | mesmo arquivo |
parametro.tipo_ausente | nada indicou o tipo, e o espaço de trabalho aceita mais de um | nomeie completo-AAAAMMDD.zip ou diario-AAAAMMDD.zip, ou informe process_type no sidecar | mesmo arquivo |
parametro.tipo_invalido | o tipo informado não é completo nem diario | corrija o nome ou o process_type | mesmo arquivo |
parametro.tipo_nao_liberado | o tipo existe, mas não está liberado para o seu espaço de trabalho | envie um tipo liberado, ou peça ao suporte para liberar | mesmo arquivo |
parametro.data_invalida | a data do nome (AAAAMMDD) ou de data_referencia (AAAA-MM-DD) não existe | corrija a data | mesmo arquivo |
parametro.rotina_invalida | a rotina de routine_code não existe ou não está ativa | corrija routine_code ou remova o campo | mesmo arquivo |
parametro.livro_invalido | a edição de livro_edicao_id não existe no seu espaço de trabalho | corrija livro_edicao_id ou remova o campo | mesmo arquivo |
parametro.entidade_invalida | a instituição de reporting_entity_id não existe, está inativa ou não é do seu espaço de trabalho | corrija reporting_entity_id ou remova o campo | mesmo arquivo |
parametro.teto_invalido | max_alerts_per_run não é um inteiro válido | corrija max_alerts_per_run ou remova o campo | mesmo arquivo |
admissao.entidade_ambigua | há mais de uma instituição ativa e nada indicou qual | informe reporting_entity_id no sidecar (enviado antes do ZIP), ou peça ao suporte uma instituição padrão | mesmo arquivo |
admissao.rotina_ambigua | há mais de uma rotina ativa e nada indicou qual | informe routine_code no sidecar (enviado antes do ZIP), ou peça ao suporte uma rotina padrão | mesmo arquivo |
Admissão e processamento
| Código | O que significa | O que fazer | Reenvio |
|---|---|---|---|
admissao.recusada | o arquivo não passou na validação de admissão | corrija o arquivo conforme o detalhe | arquivo corrigido |
admissao.entidade_ausente | o espaço de trabalho não tem instituição ativa | fale com o suporte | mesmo arquivo |
admissao.fora_do_escopo | o espaço de trabalho não tem permissão para este processamento | fale com o suporte | — |
admissao.falha_persistente | a admissão falhou repetidamente por erro do nosso lado | fale com o suporte informando o arquivo e o horário | mesmo arquivo |
processamento.falhou | o processamento terminou com erro | reenvie; se a falha é do arquivo, corrija e reenvie; se persistir, fale com o suporte informando o execution_id | mesmo arquivo |
processamento.cancelado | o processamento foi cancelado | reenvie se o processamento ainda for necessário | mesmo arquivo |
Configuração do espaço de trabalho
Estes casos são resolvidos pelo suporte da Zabit. Depois da correção, reenvie.
| Código | O que significa | Reenvio |
|---|---|---|
canal.desabilitado | o envio por bucket não está habilitado para o seu espaço de trabalho | mesmo arquivo |
workspace.padrao_invalido | a configuração padrão do espaço de trabalho (rotina, edição, instituição ou teto) deixou de ser válida | mesmo arquivo |
workspace.inexistente | o espaço de trabalho da pasta não está configurado | — |
workspace.inativo | o espaço de trabalho está inativo | — |
Duplicados
estado: duplicado. Não é erro e não há nada a fazer.
| Código | O que significa |
|---|---|
duplicado.conteudo_ja_processado | já existe um processamento do mesmo conteúdo (mesmo SHA-256), concluído ou em andamento, qualquer que seja o nome do arquivo. É o desfecho normal de um reenvio; o execution_id e o detalhe apontam o processamento original |
duplicado.reenvio_identico | o mesmo objeto, sem nova gravação, voltou a ser lido na entrada. É raro: com SSE-KMS cada envio ganha um ETag novo, e o reenvio de um arquivo sai como duplicado.conteudo_ja_processado |