
1 - Importação de dados
A importação de dados para o Informe de Rendimentos padrão é realizada por uma rotina de monitoramento de diretórios. Para o correto funcionamento dessa rotina os arquivos devem ser depositados na pasta de entrada da empresa correspondente àquele arquivo.
Também é possível efetuar a importação de um arquivo de até 1MB via API externa conforme documentado na página de DR - 01 - Especificação API - (STIR), e assim esse arquivo poderá ser lido pela rotina automática de acordo com o tempo especificado nas Configurações Gerais.
O sistema espera receber o arquivo JSON de uma competência específica com o seguinte padrão de nomenclatura: AAAAMM_SIGLA_SEQUENCIAL.json (ex.: 202513_CC_00001.json).
Inicialmente só serão aceitas competências anuais para processamento, portanto, é imprescindível que os arquivos importados estejam no formato de competência anual com os dígitos finais referentes ao mês com o valor "13", conforme exemplo acima.
1.1 - Pré-requisitos:
- Empresa cadastrada no sistema com mesmo código empresa do arquivo.
- Interface Origem cadastrada no sistema com mesma sigla de interface de origem do arquivo.
- Configuração Geral devidamente preenchida com diretórios de importação e geração.
1.2 - Visão Geral do Processo:
- Disponibilização (Manual/Externa): O arquivo JSON deve ser salvo na pasta de entrada correspondente à empresa desse arquivo, no caso da entrada via API o arquivo será armazenado na pasta referente ao código empresa passado como parâmetro.
- Detecção e Processamento (Automático): Um Job agendado varre periodicamente as pastas de entrada, cria as pastas das empresas que tiverem sido cadastradas no sistema caso não tenha sido criadas ainda, valida os arquivos, processa o conteúdo (pasta processando) e move os arquivos para as pastas de destino conforme o resultado (sucesso, aviso ou erro).
1.3 - Estrutura de Diretórios:
A estrutura de pastas segue as empresas cadastradas no sistema.
- Padrão de entrada: {Diretorio_Raiz_Configurado}/{CODIGO_EMPRESA}/entrada/
- Diretorio_Raiz_Configurado: Caminho base definido nas Configurações Gerais do sistema.
- CODIGO_EMPRESA: Código numérico da empresa (ex: 12345).
Exemplo: Se o diretório raiz for C:\Users\usuario\produto_informe_rendimentos\dados\importacao e a empresa for 11111, o arquivo deve ser salvo em: C:\Users\usuario\produto_informe_rendimentos\dados\importacao\11111\entrada\
Veja mais detalhes da estrutura de pastas na página correspondente em DR - 02 - Estrutura de Pastas (importação) - (STIR).
1.4 - Padrão de Nomenclatura do Arquivo:
O sistema irá mover para pasta de erros arquivos que não sigam estritamente o padrão de nomenclatura abaixo.
- Formato: AAAAMM_CC_NNNNN.json
- AAAAMM: Competência (Ano e Mês). Ex: 202513 (Anual).
- CC: Sigla da Interface de Origem (2 letras maiúsculas). Ex: DP, MN.
- NNNNN: Sequencial numérico (5 dígitos). Ex: 00001.
- Extensão: Obrigatório ser .json.
Exemplos:
202513_CC_00001.json (Válido)
202113_CF_99999.json (Válido)
202513_CC_1.json (Inválido - sequencial curto)
dados_importacao.json (Inválido - fora do padrão)
1.5 - Detalhes do Arquivo:
O conteúdo do arquivo deve estar em formato JSON válido e conter a estrutura abaixo. Veja a estrutura completa na página de DR - 03 - Instruções para preenchimento do arquivo de entrada (JSON) - (STIR).
{
"Empresa": {
"CodigoEmpresa": "12345", // Deve existir no sistema empresa com tal código
"SiglaInterface": "CC", // Deve existir na tabela de interfaces de origem
"Competencia": "202513", // Formato AAAAMM (13 = Anual) - sem acento
"ListaDeclarantes": [...]
}
} |
Validação de Cabeçalho (Erro Impeditivo)
Os dados dentro do objeto Empresa são validados contra o banco de dados:
- CodigoEmpresa: precisa existir empresa com mesmo código cadastrada no sistema
- SiglaInterface: precisa existir interface de origem cadastrada no sistema com mesma sigla
- Competencia: precisa estar no mesmo formato da nomenclatura do arquivo AAAAMM (13 = Anual).
Se houver divergência, o arquivo é movido imediatamente para a pasta erro e nada é processado.
Detalhe dos Declarantes e Rendimentos
O sistema aceita declarantes Pessoa Física (F) e Jurídica (J).
- Declarante:
- Fonte Pagadora (Lista):
- Agência/Conta (Lista):
- Rendimentos Isentos (Lista - Tabela 02)
- Tributação Exclusiva (Lista - Tabela 03)
- Bens e Direitos (Lista - Tabela 04)
- Dívidas e Ônus (Lista - Tabela 05)
Ciclo de Vida e Pastas de Saída
O sistema move o arquivo automaticamente entre pastas para indicar o status do processamento.
NÃO REMOVA arquivos das pasta processando manualmente, pois inconsistências podem ser geradas por essas movimentações.
- /entrada: Local onde o usuário deposita o arquivo. O sistema lê daqui.
- /processando: O sistema move o arquivo para cá enquanto lê e grava no banco.
Destino Final (Pós-processamento):
- /sucesso: Todos os registros foram importados corretamente.
- /aviso: O arquivo foi importado, mas alguns declarantes/itens falharam (erros de negócio) e foram ignorados. O restante foi salvo.
- /erro: Falha crítica (JSON inválido, cabeçalho incorreto, erro de banco). Nada foi salvo.
Monitoramento de Erros
Para saber o motivo de um arquivo ter ido para a pasta /erro ou /aviso, utilize a tela de Monitoramento da Importação, emita um Relatório de Erros de Importação referente àquela importação de interesse ou a API de consulta de erros.
- Erros Impeditivos (Pasta Erro): Geralmente problemas estruturais como:
- JSON quebrado
- CodigoEmpresa no JSON não cadastrado no sistema ou em formato inválido
- SiglaInterface inexistente no sistema ou formato inválido
- Permissões insuficientes para criação das pastas ou movimentação dos arquivos
- Erros de Negócio (Pasta Aviso):
- Cliente:
- CPF/CNPJ inválido para cliente, ou combinação inválida (informado PF, mas fornecido CNPJ e vice-versa) - obrigatório
- Nome vazio ou excede 255 caracteres - obrigatório
- Tipo de pessoa inválida (valores aceitos F e J) - obrigatório
- Fonte Pagadora:
- Nome vazio ou excede 255 caracteres - obrigatório
- CNPJ inválido - obrigatório
- Agência e Conta:
- Código de Domínio (Rendimento) não existente. Esses erros são registrados individualmente na tabela de erros do sistema.
2 - Consulta Status Importação
3 - Geração de informe
4 - Consultar resultado de geração