Arquivos remessa (CNAB) - Introdução
O arquivo transmitido nesta chamada deve seguir o padrão de Layout de Arquivo de Cobrança com 400 posições da QI Tech. Segue link para download do manual: Layout de Cobrança - QI Tech versão 2.1.
Os arquivos remessa (CNAB) oferecem a possibilidade de enviar várias instruções de registros de boleto, juntamente com outros tipos de instrução (extensão, abatimento, baixa etc.), para diferentes boletos, em um único arquivo. Ao enviar instruções como as mencionadas (extensão, abatimento etc.), para boletos já existentes, o boleto é identificado pelo código da carteira (requester_profile_code) e pelo nosso número (our_number).
Ao fazer o upload de um arquivo CNAB, caso a requisição tenha sucesso (código de resposta 202), será criado um arquivo CNAB temporário (TemporaryCNABFile). É possível consultar o status de processamento do arquivo --- bem como possíveis erros, tanto no próprio arquivo quanto em suas ocorrências ---, utilizando os endpoints de consulta de arquivo CNAB temporário e suas ocorrências.
O arquivo será rejeitado caso seja encontrado qualquer erro sintático. No entanto, ele é lido integralmente, ou até que sejam encontrados um limite de 100 erros, para que todos os erros possam ser retornados e corrigidos de maneira mais prática e eficiente.
Enquanto o arquivo é lido, são criadas ocorrências temporárias, que só serão processadas caso ele seja aceito. Ou seja, se o arquivo for rejeitado (status rejected), todas as suas ocorrências também serão. Ademais, se o arquivo for rejeitado, não são mais criadas ocorrências temporárias para o mesmo. Portanto, é comum que as entradas de arquivos rejeitados possuam menos ocorrências do que a quantidade de ocorrências enviada no arquivo.
Por outro lado, no momento em que o arquivo é totalmente lido e aceito (status read), inicia-se a criação das ocorrências definitivas, que serão as instruções que valerão de fato. Se uma ocorrência temporária apresenta o status rejected (rejeitada), significa que foi encontrado algum erro semântico na mesma --- ou seja, algum erro no seu conteúdo. Nesse caso, haverá um objeto error_data junto a mesma, que fornece detalhes acerca do motivo de rejeição. Em contrapartida, se apresentar o status processed, significa que a ocorrência definitiva já foi criada e enviada para a CIP/Nuclea. Maiores detalhes a respeito de cada uma dessas entidades são fornecidos nas páginas subsequentes, de consulta de arquivos e ocorrências temporárias.