ÁREA DO
O objetivo deste Layout é especificar a estrutura do arquivo de como os dados contábeis oriundos de um sistema contábil de terceiros deverão ser gerados e exportados em arquivo do tipo texto para a correta importação do Módulo Importador no Sistema CLM – Contabilidade Integrada.
-
SOBRE ESTE DOCUMENTO
O objetivo deste documento é especificar a estrutura do arquivo de como os dados contábeis oriundos de um sistema contábil de terceiros deverão ser gerados e exportados em arquivo do tipo texto para a correta importação do Módulo Importador.
-
DESCRIÇÃO DA ESTRUTURA DO ARQUIVO
Arquivos
Cada arquivo de dados para importação deve conter informações de apenas uma empresa cadastrada no sistema da Copan.
Blocos
As linhas no arquivo (.txt) devem representar um conjunto de campos denominado bloco. A separação dos campos é feita por “pipes” (|), conforme a ilustração a seguir:
____________bloco______________
CAD01|66|1234|-++-|5|9.9.9.99.999||||
_campo_
Campos
Os blocos são subdivididos por campos, delimitados por pipes (“|”). Atenção: Os pipes de cada campo são obrigatórios, mesmo que não haja valor informado.
A primeira linha deve sempre conter o Cabeçalho do Arquivo em que são definidas as informações sobre versão, compatibilidade e empresa de cada arquivo de dados.
-
TABELAS DE ESPECIFICAÇÃO DO BLOCO
O conteúdo de cada bloco – seus campos, valores e tipo respectivos, obrigatoriedade, etc., estão descritos na tabela de referência de cada um.
Níveis
Os níveis (ou grau de hierarquia) são definidos pela indentação dos blocos. A indentação correta para cada bloco está definida na tabela de especificação do mesmo.
Ocorrência
A ocorrência (ou repetição dos blocos) é a quantidade de vezes que determinada estrutura de bloco irá aparecer no arquivo. O número de vezes em que aparece varia conforme os dados.
CAD02|1|1|1|1|ATIVO
CAD02|11|1.1|2|1|CIRCULANTE
CAD02|111|1.1.1|3|1|DISPONIVEL
CAD02|1111|1.1.1.01|4|1|BENS NUMERARIOS
(…)
Os únicos blocos que nunca irão se repetir são: o cabeçalho do arquivo, que identificam as versões da estrutura e do importador e a empresa. Obrigatoriamente deve-se gerar um arquivo por empresa. Todos os outros blocos variam conforme os dados.
N° (Número)
O número indica a posição do campo dentro do bloco.
Campo
Identificação de cada campo.
Obrigatoriedade
Obrigatoriedade do campo: S (sim) ou N (não). Indica se é necessário, ou não, o preenchimento do campo. Pode haver casos em que a obrigatoriedade de um campo esteja condicionada ao preenchimento de outro.
Obs.: O número de campos para cada bloco deve sempre estar de acordo com o descrito em sua tabela. Os campos que NÃO forem preenchidos devem aparecer vazios.
Tipo
Indica o tipo de saída do caractere:
C – Caractere (valores do tipo texto) N – Valores do tipo numéricos
Tamanho
Quantidade de caracteres do campo.
Valor
O valor do campo pode ser fixo ou variar de acordo com os dados.
- DEFINIÇÃO DA ESTRUTURA DO ARQUIVO E DOS BLOCOS COPAN – Bloco de Cabeçalho do Arquivo
Este bloco contém as informações que identificam a versão e compatibilidade com o importador da
estrutura do arquivo. Além, da identificação (pelo código) de cada empresa. A importação será feita
somente se a empresa informada no arquivo, já estiver cadastrada no sistema.
| COPAN – BLOCO DE CABEÇALHO DO ARQUIVO | |||||
| OCORRÊNCIA: 01 – NÍVEL 01 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “COPAN” |
| 02 | VERSÃO DA ESTRUTURA | S | N | – | 2 |
| 03 | VERSÃO MÍNIMA DO IMPORTADOR | S | N | – | 2 |
| 04 | CÓDIGO DA EMPRESA | S | N | – | – |
| 05 | CNPJ | S/N | N | 14 | – |
| 06 | CPF | S/N | N | 11 | – |
| 07 | CEI | S/N | N | 12 | – |
| 08 | CÓDIGO DA MATRIZ | N | N | – | – |
| 09 | DATA INICIAL | S | N | 8 | – |
| 10 | DATA FINAL | S | N | 8 | – |
Observações:
Campo 01 – Valor fixo identificando o arquivo.
Campo 02 – Versão do Importador da estrutura do arquivo. É importante ressaltar que, via de regra, as novas versões de importadores deverão manter compatibilidade com estruturas antigas.
Campo 03 – A versão mínima deve ser sempre igual ou superior a “2”. Versões anteriores a esta fazem referência ao antigo importador desenvolvido em DOS.
Campo 04 – Código da empresa, previamente cadastrado, no sistema da Copan. Cada empresa deve ser representado por um arquivo texto gerado.
Campos 05, 06 e 07 – Pelo menos um destes campos deve ser informado para que seja possível a importação dos dados contábeis. Apresentar sem formatação.
Campo 08 – Código da matriz/construtora. Se não houver, deixar em branco.
Campo 09 – Data inicial referente aos dados dos lançamentos. Apresentar sem mascaras. Campo 10 – Data final referente aos dados dos lançamentos. Apresentar sem mascaras.
Modelo do Bloco:
COPAN|2|2|1234|91509901000169||||01012010|31122010
CAD01 – Blocos de Cadastro do Plano de Contas
Informações sobre os Planos de Contas para o cadastro.
É necessário informar o plano ativo para a empresa antes de importar os dados, para isso, se necessário, crie no sistema um plano sem contas, com o mesmo código e classificação do informado no arquivo.
| CAD01 – BLOCOS DE CADASTRO DO PLANO DE CONTAS | |||||
| OCORRÊNCIA: N – NÍVEL 02 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “CAD01” |
| 02 | CÓDIGO DO PLANO | S | N | – | – |
| 03 | GRUPOS DO PLANO | S | C | 6 | 1 A 6 |
| 04 | SINAIS DO PLANO | S | C | 6 | SEQ +/- |
| 05 | TOTAL DE NÍVEIS | S | N | – | – |
| 06 | FORMATO DO PLANO | S | C | 20 | – |
Observações:
Campo 02 – Caso já exista um plano cadastrado com o código informado, o sistema não importará o mesmo. O usuário deverá verificar no sistema um código disponível para o novo plano.
Campo 03 – Seqüência que informa a numeração dos grupos do plano, ativo, passivo, receita, despesa, custo, resultado.
Campo 04 – Sinais referentes à seqüência informada no campo Grupos do Plano (03) sendo o – (sinal negativo) devedor e + (sinal positivo) credor.
Campo 05 – Numero que representa o total de níveis hierárquicos que o plano possui. Obs. As contas dos últimos níveis são analíticas e as contas em níveis hierárquicos superiores são as contas sintéticas.
Campo 06 – Formato do Plano, ex.: 9.9.9.99.999.
Modelo de Bloco:
CAD01|77|1234|-++-|5|9.9.9.99.999
CAD02 – Blocos de Cadastro das Contas Contábeis do Plano
Este bloco apresenta as contas do Plano de Contas descrito acima.
| CAD02 – BLOCOS DE CADASTRO DAS CONTAS CONTÁBEIS DO PLANO | |||||
| OCORRÊNCIA: N – NÍVEL 03 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “CAD02” |
| 02 | CÓDIGO DA CONTA | S | C | 10 | – |
| 03 | CLASSIFICAÇÃO | S | C | 20 | – |
| 04 | NÍVEL | S | N | – | – |
| 05 | TIPO | S | N | – | – |
| 06 | NOME DA CONTA | S | C | 60 | – |
| 07 | CÓDIGO DO HISTÓRICO | N | N | – | – |
| 08 | CONCILIAR | N | N | 1 | 0/1 |
Observações:
Campo 02 – Se o código da conta já estiver cadastrado, o sistema irá para o próximo registro. A relação de contas novas cadastradas fica disponível no histórico de ocorrências do importador.
Campo 03 – Classificação da conta contábil. Ex.: 1.01.01.001. Campo 04 – Nível hierárquico no qual a conta se encontra.
Campo 05 – Informar Tipo da Conta:
- – Sintética Normal;
- – Sintética de Fornecedores; 03 – Sintética de Clientes;
10 – Analítica;
12 – Analítica de Fornecedores; 13 – Analítica de Clientes.
Campo 06 – Descrição da conta. Ex.: Ativo.
Campo 07 – Código do histórico padrão, o qual será automaticamente informado quando o usuário for fazer um lançamento. O mesmo poderá ser alterado no momento do lançamento.
Campo 08 – Informar caso o saldo da conta possa ser conciliado.
Modelo de Bloco:
CAD02|24242|2.4.2.03.012|5|10|RESULTADO DE SETEMBRO|1
CAD03 – Blocos de Cadastro de Históricos Padrões
Este bloco apresenta os históricos padrões para cadastro.
| CAD03 – BLOCOS DE CADASTRO DE HISTÓRICOS PADRÕES | |||||
| OCORRÊNCIA: N – NÍVEL 02 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “CAD03” |
| 02 | CÓDIGO | S | N | – | – |
| 03 | DESCRIÇÃO | S | C | 60 | – |
| 04 | EDITÁVEL | N | N | 1 | 0/1 |
| 05 | COMPLEMENTAR | N | N | 1 | 0/1 |
Observações:
Campo 02 – Caso já exista um histórico cadastrado com o código informado, o sistema não importará o registro. O usuário deverá verificar um código disponível para os novos históricos padrões.
Campo 03 – Nome do histórico padrão. Ex.: Adiantamento de Salário. Campo 04 – Digite 1 (um) caso o usuário possa editar no lançamento.
Campo 05 – Digite 1 (um) caso o usuário possa complementar o histórico no lançamento.
Modelo de Bloco:
CAD03|12|COMPRAS CONF. NF.|0|1
CAD04 – Blocos de Cadastro de Centro de Custos
Este bloco apresenta centro de custos para cadastro.
| CAD04 – BLOCOS DE CADASTRO DE CENTROS DE CUSTOS | |||||
| OCORRÊNCIA: N – NÍVEL 02 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “CAD04” |
| 02 | CÓDIGO | N | C | 6 | – |
| 03 | DESCRIÇÃO | S | C | 40 | – |
Observações:
Campo 02 – Caso já exista um centro de custo cadastrado com o código informado, o sistema não importará o registro. O usuário deverá verificar um código disponível para os novos centros de custos ou informar o campo vazio.
Campo 03 – Descrição do centro de custos.
Modelo de Bloco:
CAD04|000010|COMERCIAL
LCT01 – Blocos de Lançamentos Contábeis – Cabeçalho
Esta tabela apresenta os campos dos blocos Lançamentos Contábeis
| LCT01 – BLOCOS DE LANÇAMENTOS CONTÁBEIS – CABEÇALHO | |||||
| OCORRÊNCIA: N – NÍVEL 02 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “LCT01” |
| 02 | CÓDIGO DA CONTABILIDADE | N | N | – | – |
| 03 | CÓDIGO DO LANÇAMENTO | N | N | – | – |
| 04 | DATA | N | C | 8 | – |
| 05 | NÚMERO DO DOCUMENTO | N | N | – | – |
| 06 | VALOR TOTAL | S | N | – | – |
| 07 | SIMPLES | S | N | 1 | 0/1 |
| 08 | REGISTRO | S | N | – | – |
| 09 | CÓDIGO DO PLANO | S | N | – | – |
Observações:
Campo 02 – Caso não seja informado, o sistema cadastrará automaticamente a próxima posição válida (maior valor do último cadastrado+1).
Campo 03 – Caso não seja informado, o sistema cadastrará automaticamente a próxima posição válida (maior valor do último cadastrado+1).
Campo 04 – Data do lançamento sem formatação. Ex: 13/03/2010 -> 13032010. Campo 05 – Numero do documento referente ao lançamento.
Campo 06 – Valor total considerando duas casas decimais.
Campo 07 – Informar se o lançamento e simples (apenas um débito) ou múltiplo.
- 0 – Múltiplo;
- 1 – Simples;
Campo 08 – Origem do lançamento:
- 0 – Próprio CLM;
- 1 – Compra (Escrita Fiscal);
- 2 – Vendas (Escrita Fiscal);
- 3 – Serviços Modelo 51 (Escrita Fiscal);
- 4 – Serviços Modelo 53 (Escrita Fiscal);
- 5 – serviços Contratados (Escrita Fiscal).
Campo 09 – Código do plano referente ao lançamento.
Modelo de Bloco:
LCT01|1232|5532|04032010|2|24412|S|4|1|99
LCT02 – Blocos de Lançamentos Contábeis – Itens
A tabela abaixo apresenta os campos de itens referentes aos blocos dos lançamentos contábeis.
| LCT02 – BLOCOS DE LANÇAMENTOS CONTÁBEIS – ITEM | |||||
| OCORRÊNCIA: N – NÍVEL 03 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “LCT02” |
| 02 | SEQUENCIAL | N | N | – | – |
| 03 | CÓDIGO DO PLANO | S | N | – | – |
| 04 | CÓDIGO DA CONTA | S | C | 10 | – |
| 05 | CÓDIGO DO HISTÓRICO | S | N | – | – |
| 06 | NOME DO HISTÓRICO | S/N | C | 100 | – |
| 07 | COMPLEMENTO | N | C | 512 | – |
| 08 | VALOR | S | N | – | – |
| 09 | INDICADOR VALOR | S | N | – | 0/1 |
Observações:
Campo 02 – Caso não seja informado, o sistema cadastrará automaticamente a próxima posição válida (maior valor do último cadastrado+1).
Campo 03 – Código do plano o qual possui a conta informada no campo 04. Campo 04 – Código que indica a que conta pertence.
Campo 05 – Código do histórico padrão.
Campo 06 – Nome do histórico deve ser informado apenas se o histórico for editável.
Campo 07 – Complemento do histórico padrão digitado pelo usuário para complementar a informação do lançamento.
Campo 08 – Valor total considerando-se duas casas decimais.
Campo 09 – Indica se o valor é débito (0) ou crédito (1). Os valores totais de débito e crédito devem ser iguais. E, o total de débito ou de crédito deve bater com o Valor Total do bloco de Lançamentos Contábeis.
Modelo de bloco:
LCT02|03|4324|9575|44|HISTORICO1|Complemento1|500|0 LCT02|04|3223|3342|66|HISTORICO2|Complemento2|250|1 LCT02|05|5237|2356|92|HISTORICO6|Complemento5|250|1
LCT03 – Blocos de Lançamentos Contábeis – Itens – Centro de Custo
A tabela abaixo apresenta os campos de itens referentes aos blocos dos lançamentos de centro de custos para cada item de lançamento.
| LCT03 – BLOCOS DE LANÇAMENTOS CONTÁBEIS – ITEM – CENTRO DE CUSTO | |||||
| OCORRÊNCIA: N – NÍVEL 04 | |||||
| Nº | CAMPO | OBRIG | TIPO | TAM | VALOR |
| 01 | IDENTIFICAÇÃO | S | C | 5 | “LCT03” |
| 02 | SEQUENCIAL | N | N | – | – |
| 03 | CÓDIGO DO CENTRO DE CUSTO | N | C | 6 | |
| 04 | VALOR | S | N | – | – |
Observações:
Campo 02 – Caso não seja informado, campo sem valor, o sistema cadastrará automaticamente a próxima posição válida (maior valor do último cadastrado+1).
Campo 03 – Código do centro de custo, previamente cadastrado ou cadastrado no CAD04.
Campo 04 – Valor do lançamento no centro de custo informado. Apresentar sem formatação, considerando duas casas decimais.
Atenção: A some de todos os LCT03 deve ser igual ao valor informado no LCT01 de sua referencia.
Modelo de bloco:
LCT02|03|4324|9575|44|HISTORICO1|Complemento1|500|0 LCT03|04|000100|250
LCT03|05|000200|250
ERROS E SOLUÇÕES
Lista de possíveis erros apresentados no histórico de ocorrências relacionadas à importação e suas respectivas soluções.
“CNPJ do emitente que está no arquivo a ser importado não está cadastrada no COPAN !”
Cadastrar ou verificar se o CNPJ informado no arquivo a ser importado está no sistema da COPAN.
“Empresa selecionada não é a mesma do arquivo a ser importado!”
Selecionar empresa correta para importação.
“Erro de Dados do Bloco Cad01(Linha) – O código do plano xxx já está cadastrado no COPAN. A importação será abortada”
Alterar o código do plano. Verifique no sistema da COPAN a opção Plano de Contas \ Propriedade do Plano.
Localize um código de plano que esteja disponível. Altere o sistema do cliente e gere novamente o arquivo para importação.
“Erro de Dados do Bloco Cad02(Linha). O código da conta xxx do plano xxx já está cadastrado no COPAN a importação será abortada !”
O usuário deverá alterar o código da conta ou excluí-la do arquivo.
“Erro de Dados do Bloco Cad03(Linha) – Tabela de Histórico Padrão. Importação abortada.”
Alterar o código do histórico. Lembrando-se de alterar também, nos blocos subsequentes.
“Erro de Dados do Bloco Cad04(Linha) – O código xxxxxx de Centro de Custo já cadastrado”
Alterar o código do centro de custo. Lembrando-se de alterar também, nos blocos subsequentes.
“Erro de Dados do Bloco LCT01(Linha) – Lançamento Contábil já efetuado.”
Verificar os dados do lançamento, sendo o caso altera-los ou remover o lançamento do arquivo. Lembrando-se de alterar também, nos blocos subsequentes.
“Erro de Dados do Bloco LCT02(Linha) – Item de lançamentos – Conta não cadastrada.”
Verificar se a conta informada realmente existe no arquivo ou se já este cadastrado no sistema.
“Erro de Dados do Bloco LCT03(Linha) – Centro de Custo xxxxxx não esta cadastrado.”
Verificar se o centro de custo informado realmente existe no arquivo ou se já este cadastrado no sistema.
