No Office Banking, as implementações foram feitas seguindo o padrão CNAB. Esse padrão utiliza uma estrutura de arquivo dividida em blocos, começando com um cabeçalho (Header) e terminando com (Trailer), como mostrado na figura abaixo.
É essencial configurar corretamente os formatos HBK para ler e importar essa estrutura, a fim de evitar incidentes no processamento dos documentos de retorno. Inclusive, as linhas de rodapé (trailer) também precisam ser importadas, pois indicam o fim do lote e do arquivo.
Estrutura do arquivo CNAB ↴
Header arquivo
|
|-- Header lote
| |
| |-- Detalhe principal
| |-- Detalhe opcional
| |
|-- Trailer lote
|
Trailer arquivo
Gerador de Formatos - Tipos de linha ↴
Aqui estão as características de cada tipo de linha disponível para a geração do formato dos arquivos;
Tipos de Linha
|
Características
|
| Header |
● Primeira linha do arquivo.
● Obrigatório no envio e no retorno.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
|
| Header de Lote |
● Primeira linha do lote.
● Para os layouts bancários que agrupam os documentos em lotes, essa linha é obrigatória no envio e no retorno.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
|
| Detalhe Principal |
● Linha com os detalhes do documento.
● Pode ser usada para pagamento e cobrança.
● Essa linha é gerada no envio e importada no retorno e é usada nos layouts que possuem apenas uma linha de detalhe por documento.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
|
| Detalhe Opcional |
● Linha com detalhes opcionais do documento.
● Pode ser usada para pagamento e cobrança.
● Esse tipo de linha é gerada no envio, mas não é importada no retorno.
● O formato HBK pode ser configurado com mais de uma linha desse tipo, como também pode não ter essa linha.
|
| Mensagem |
● Linha com informações adicionais ou mensagens do documento.
● Pode ser usada para pagamento e cobrança.
● Esse tipo de linha é gerada no envio, mas não é importada no retorno.
● O formato HBK pode ser configurado com mais de uma linha desse tipo, como também pode não ter essa linha.
|
| Trailer de Lote |
● Última linha do lote.
● Para os layouts bancários que agrupam os documentos em lotes, essa linha é obrigatória no envio e no retorno.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
|
| Trailer |
● Última linha do arquivo.
● Obrigatório no envio e no retorno.
|
| Detalhe Principal 1 (Cobrança) |
● Primeira linha com os detalhes do documento.
● Exclusiva para cobrança.
● Essa linha é gerada no envio e importada no retorno e é usada nos layouts que possuem duas ou três linhas de detalhe por documento.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
|
| Detalhe Principal 2 (Cobrança) |
● Segunda linha com os detalhes do documento.
● Exclusiva para cobrança.
● Essa linha é gerada no envio e importada no retorno e é usada nos layouts que possuem duas ou três linhas de detalhe por documento.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
● Nos layouts com duas linhas por documento, esta é a linha que completa a importação das
informações para o processamento do documento.
|
| Detalhe Principal 3 (Cobrança) |
● Terceira linha com os detalhes do documento.
● Exclusiva para cobrança.
● Essa linha é gerada no envio e importada no retorno e é usada nos layouts que possuem três linhas de detalhe por documento.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
● Nos layouts com três linhas por documento, esta é a linha que completa a importação das
informações para o processamento do documento.
|
| Detalhe Principal 1 (Pagamento) |
● Primeira linha com os detalhes do documento.
● Exclusiva para pagamento.
● Essa linha é gerada no envio e importada no retorno e é usada nos layouts que possuem duas linhas de detalhe por documento.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
|
| Detalhe Principal 2 (Pagamento) |
● Segunda linha com os detalhes do documento.
● Exclusiva para pagamento.
● Essa linha é gerada no envio e importada no retorno e é usada nos layouts que possuem duas linhas de detalhe por documento.
● O formato HBK deve ser configurado com somente uma linha desse tipo.
● Nos layouts com duas linhas por documento, esta é a linha que completa a importação das
informações para o processamento do documento. |
