CIGAM WIKI - Contribuições do usuário [pt-br]

CT EDI Contratos CIGAM

2026-06-15T16:51:50Z

Bruno.walzer:

[[Finanças]] > [[CT_Contratos|Contratos]] > [[CT_Rotinas|Rotinas]] > [[CT_Rotinas_EDI|EDI]] > [[CT_Rotinas_EDI_Recebe|Recebe]] > [[CT_EDI Contratos CIGAM|EDI Contratos CIGAM]]

== EDI Contratos CIGAM ==

 
[[Image: importacigm.png|500px|centro]]
 

== Descrição ==
A rotina '''EDI Contratos CIGAM''' (CG03294) permite importar contratos para o CIGAM a partir de um arquivo texto externo, seguindo layout posicional definido para a rotina.

Por meio do arquivo de importação, é possível informar:

* Dados principais do contrato;
* Observações e descrições complementares;
* Parâmetros para geração das parcelas;
* Itens vinculados ao contrato.

Durante o processamento, o sistema realiza validações sobre os dados informados no arquivo antes de efetivar a importação. Caso sejam identificadas inconsistências, a rotina apresenta as mensagens de erro correspondentes, permitindo a correção do arquivo antes de uma nova tentativa.

Após a validação, a rotina realiza a criação do contrato, dos itens e das parcelas conforme as informações recebidas no arquivo.

== Pré-requisito ==
Para utilizar esta rotina, é necessário que os cadastros referenciados no arquivo estejam previamente cadastrados no sistema, quando informados no layout.

Entre os principais cadastros validados pela rotina, estão:

* Empresa/Pessoa;
* Portador;
* Conta financeira;
* Código do material;
* Objeto;
* Tipo de operação.

O contrato informado no arquivo não deve existir previamente no sistema, pois a rotina realiza a validação de existência antes da importação.

== Localização no sistema ==
'''Finanças → Contratos → Rotinas → EDI → Recebe → EDI Contratos CIGAM'''

== Como utilizar ==

=== 1. Preparar o arquivo de importação ===
O arquivo deve ser texto, '''posicional (largura fixa)''', '''sem delimitador''' — os campos são identificados pela posição inicial e final de cada informação.

Cada linha do arquivo deve iniciar com um identificador de registro, responsável por indicar o tipo de informação que está sendo importada.

O arquivo pode conter diferentes tipos de registro:

== Estrutura do arquivo ==

=== Linha tipo C - Contrato ===
Registro utilizado para informar os dados principais do contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''C'''
|-
| Código do Contrato
| v_C_Contrato
| A8
| 5
| 12
| Código do contrato a ser importado. Não deve existir previamente no sistema.
|-
| Descrição do Contrato
| v_C_Descricao
| A60
| 14
| 73
| Descrição principal do contrato.
|-
| Natureza
| v_C_Natureza
| A1
| 75
| 75
| Natureza do contrato.
|-
| Tipo
| v_C_Tipo
| A1
| 77
| 77
| Tipo do contrato.
|-
| Objeto
| v_C_Objeto
| A10
| 79
| 88
| Código do objeto. Deve estar cadastrado no sistema.
|-
| Contratante
| v_C_Contratante
| A6
| 90
| 95
| Código da empresa/pessoa contratante.
|-
| Cobrança
| v_C_Cobrança
| A6
| 97
| 102
| Código da empresa/pessoa utilizada para cobrança.
|-
| Cliente
| v_C_Cliente
| A6
| 104
| 109
| Cliente vinculado ao contrato.
|-
| Contrato Repasse
| v_C_Contrato Repasse
| A8
| 111
| 118
| Informar quando aplicável.
|-
| Avalista 1
| v_C_Avalista 1
| A6
| 120
| 125
| Informar quando aplicável.
|-
| Avalista 2
| v_C_Avalista 2
| A6
| 127
| 132
| Informar quando aplicável.
|-
| Fiador
| v_C_Fiador
| A6
| 134
| 139
| Informar quando aplicável.
|-
| Contato
| v_C_Contato
| A15
| 141
| 155
| Contato relacionado ao contrato.
|-
| Pedido
| v_C_Pedido
| A12
| 157
| 168
| Pedido relacionado ao contrato, quando houver.
|-
| Vigência Inicial
| v_C_Vigencia Inicial
| D10
| 170
| 179
| Data no formato '''DD/MM/YYYY'''.
|-
| Vigência Final
| v_C_Vigencia Final
| D10
| 181
| 190
| Data no formato '''DD/MM/YYYY'''.
|-
| Dia de Vencimento
| v_C_Dia Vencimento
| N2
| 192
| 193
| Dia de vencimento das parcelas.
|-
| Renovação
| v_C_Renovacao
| L1
| 195
| 195
| Informar '''S''' ou '''N'''.
|-
| Limite Renovação
| v_C_Limite Renovacao
| D10
| 197
| 206
| Data no formato '''DD/MM/YYYY'''.
|-
| Data Renovação
| v_C_Data Renovacao
| D10
| 208
| 217
| Data no formato '''DD/MM/YYYY''', quando aplicável.
|-
| Data Cancelamento
| v_C_Data Cancelamento
| D10
| 219
| 228
| Data no formato '''DD/MM/YYYY''', quando aplicável.
|-
| Motivo Cancelamento
| v_C_Motivo Cancelamento
| A2
| 230
| 231
| Motivo de cancelamento, quando aplicável.
|-
| Valor Parcela
| v_C_Valor Parcela
| N11,2
| 233
| 246
| Valor da parcela do contrato.
|-
| Data Base
| v_C_Data_Base
| D10
| 249
| 258
| Data base para cálculo/reajuste.
|-
| Índice
| v_C_Indice
| A5
| 271
| 275
| Índice utilizado no contrato.
|-
| Juros ao Mês (%)
| v_C_Juros Mes Percentual
| N3,2
| 277
| 282
| Percentual de juros mensal.
|-
| Limite Multa em Dias
| v_C_Limite Multa Dias
| N3
| 284
| 286
| Quantidade de dias para aplicação de multa.
|-
| Percentual Multa
| v_C_Percentual Multa
| N3,2
| 288
| 293
| Percentual de multa.
|-
| Conta Financeira
| v_C_Conta
| A6
| 295
| 300
| Conta financeira principal. Deve estar cadastrada.
|-
| Conta Multa
| v_C_Conta Multa
| A6
| 302
| 307
| Conta financeira para multa.
|-
| Conta Reajuste
| v_C_Conta Reajuste
| A6
| 309
| 314
| Conta financeira para reajuste.
|-
| Conta Juros
| v_C_Conta Juros
| A6
| 316
| 321
| Conta financeira para juros.
|-
| Conta Desconto
| v_C_Conta Desconto
| A6
| 323
| 328
| Conta financeira para desconto.
|-
| Situação do Contrato
| v_C_Situacao Contrato
| A1
| 330
| 330
| Situação inicial do contrato.
|-
| Modalidade
| v_C_Modalidade
| A1
| 332
| 332
| Modalidade do contrato.
|-
| Periodicidade
| v_C_Periodicidade
| N2
| 334
| 335
| Periodicidade do contrato.
|-
| Portador Cobrança
| v_C_Portador Cobranca
| A3
| 337
| 339
| Portador de cobrança. Deve estar cadastrado.
|-
| Tipo de Pagamento
| v_C_Tipo de Pagamento
| A2
| 341
| 342
| Tipo de pagamento utilizado no contrato.
|-
| Série NF
| v_C_Serie NF
| A5
| 344
| 348
| Série de nota fiscal relacionada.
|-
| Histórico
| v_C_Historico
| A3
| 350
| 352
| Histórico financeiro/contábil relacionado.
|-
| Valor Total
| v_C_Valor Total
| N11,2
| 354
| 367
| Valor total do contrato.
|-
| Valor Total Indexado
| v_C_Valor Total Indexado
| N11,2
| 370
| 383
| Valor total indexado, quando aplicável.
|-
| Tipo Cobrança
| v_C_Tipo Cobrança
| A1
| 399
| 399
| Tipo de cobrança do contrato.
|-
| Portador Previsão
| v_C_Portador Previsao
| A3
| 417
| 419
| Portador utilizado para previsão.
|-
| Responsável
| v_C_Responsavel
| A6
| 458
| 463
| Responsável vinculado ao contrato.
|-
| Contrato Terceiro
| v_C_Contrato Terceiro
| A15
| 661
| 675
| Contrato de terceiro, quando aplicável.
|-
| Matrícula Terceiro
| v_C_Matricula Terceiro
| A15
| 677
| 691
| Matrícula de terceiro, quando aplicável.
|-
| Contrato Assinado
| v_C_Contrato Assinado
| A1
| 910
| 910
| Indica contrato assinado.
|-
| Unidade de Negócio
| v_C_Unidade Negocio
| A3
| 927
| 929
| Unidade de negócio vinculada ao contrato.
|}

=== Linha tipo O - Observações ===
Registro utilizado para complementar as informações descritivas do contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''O'''
|-
| Observação
| v_O_Observacao
| A200
| 3
| 202
| Observação geral do contrato.
|-
| Descrição do Objeto
| v_O_Descricao Objeto
| A3001
| 204
| 3204
| Descrição complementar do objeto do contrato.
|-
| Valor por Extenso
| v_O_Valor por Extenso
| A80
| 3206
| 3285
| Valor do contrato por extenso, quando aplicável.
|}

=== Linha tipo P - Parcelas ===
Registro utilizado para informar os parâmetros de geração das parcelas do contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''P'''
|-
| Quantidade de Parcelas
| v_P_Quantidade de Parcelas
| N3
| 3
| 5
| Quantidade de parcelas a serem geradas.
|-
| Periodicidade
| v_P_periodicidade
| A2
| 7
| 8
| Periodicidade de geração das parcelas.
|-
| Primeiro Vencimento
| v_P_Primeiro Vencimento
| D10
| 10
| 19
| Data no formato '''DD/MM/YYYY'''.
|-
| Primeira Data de Lançamento
| v_P_Primeira Data Lancamento
| D10
| 21
| 30
| Primeira data de lançamento.
|-
| Portador de Previsão
| v_P_Portador de Previsao
| A3
| 32
| 34
| Portador utilizado para previsão.
|-
| Desconto até Vencimento (%)
| v_P_Desconto ate Vencimento
| N3,2
| 36
| 41
| Percentual de desconto até o vencimento.
|-
| Índice
| v_P_Indice
| A5
| 43
| 47
| Índice utilizado nas parcelas.
|-
| Gerar Lançamento Retenção
| v_P_Gerar_Lancamento Retencao
| L1
| 49
| 49
| Informar '''S''' ou '''N'''.
|-
| Contabilizar Lançamento Retenção
| v_P_Contabilizar Lancamento Ret
| L1
| 51
| 51
| Informar '''S''' ou '''N'''.
|-
| Código do Imposto
| v_P_Codigo do Imposto
| A6
| 53
| 58
| Código do imposto utilizado na retenção.
|-
| Código DARF
| v_P_Codigo DARF
| A4
| 60
| 63
| Código DARF relacionado.
|-
| Histórico de Retenção
| v_P_Historico de Retencao
| A3
| 65
| 67
| Histórico utilizado na retenção.
|-
| Conta Financeira Retenção
| v_P_Conta Fin Retencao
| A6
| 69
| 74
| Conta financeira utilizada na retenção.
|-
| Portador Retenção
| v_P_Portador Retencao
| A3
| 76
| 78
| Portador utilizado para retenção.
|-
| IRRF Abaixo do Mínimo
| v_P_IRRF_Abaixo
| A1
| 80
| 80
| Indica tratamento para IRRF abaixo do mínimo.
|-
| INSS Abaixo do Mínimo
| v_P_INSS Abaixo
| A1
| 82
| 82
| Indica tratamento para INSS abaixo do mínimo.
|}

=== Linha tipo I - Itens do Contrato ===
Registro utilizado para informar os itens vinculados ao contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''I'''
|-
| Número da Parcela
| v_I_Numero da Parcela
| N4
| 3
| 6
| Número da parcela relacionada ao item.
|-
| Sequência do Item
| v_I_Sequencia Item
| N5
| 8
| 12
| Sequência do item no contrato.
|-
| Código do Material
| v_I_Codigo do Material
| A20
| 14
| 33
| Código do material. Deve estar cadastrado no sistema.
|-
| Especificação 1
| v_I_Especif1
| A6
| 35
| 40
| Especificação complementar do material.
|-
| Especificação 2
| v_I_Especif2
| A6
| 42
| 47
| Especificação complementar do material.
|-
| Quantidade
| v_I_Quantidade
| N8,2
| 49
| 59
| Quantidade do item.
|-
| Descrição
| v_I_Descricao
| A201
| 61
| 261
| Descrição do item.
|-
| Preço Unitário
| v_I_Preco Unitario
| N10,5
| 263
| 278
| Preço unitário do item.
|-
| Data de Competência
| v_I_Data Competencia
| D10
| 280
| 289
| Data no formato '''DD/MM/YYYY'''.
|-
| Tipo de Parcela
| v_I_Tipo Parcela
| A1
| 291
| 291
| Tipo de parcela do item.
|-
| Data Base
| v_I_Data Base
| D10
| 293
| 302
| Data base do item.
|-
| Índice
| v_I_Indice
| A5
| 304
| 308
| Índice utilizado no item.
|-
| Repetição
| v_I_Repeticao
| N4
| 310
| 313
| Quantidade de repetições.
|-
| Código Produto Cliente
| v_I_Codigo Produto Cliente
| A20
| 315
| 334
| Código do produto utilizado pelo cliente.
|-
| Cliente
| v_I_Cliente
| A6
| 336
| 341
| Cliente relacionado ao item.
|-
| Cobrar
| v_I_Cobrar
| L1
| 343
| 343
| Informar '''S''' ou '''N'''.
|-
| Tipo de Operação
| v_I_Tipo Operacao
| A5
| 384
| 388
| Tipo de operação utilizado no item. Deve estar cadastrado.
|-
| Reduzido Gerencial
| v_I_Reduzido Gerencial
| A6
| 399
| 404
| Código reduzido gerencial.
|-
| Reduzido Contábil
| v_I_Reduzido Contabil
| A6
| 406
| 411
| Código reduzido contábil.
|-
| Periodicidade
| v_I_Periodicidade
| A2
| 419
| 420
| Periodicidade do item.
|-
| Buscar Regra Fiscal
| v_I_Buscar Regra Fiscal
| L1
| 437
| 437
| Informar '''S''' ou '''N'''.
|-
| Bloquear Alteração de Quantidade
| v_I_Bloquear Alteracao de Qt
| L1
| 439
| 439
| Informar '''S''' ou '''N'''.
|-
| Percentual de Desconto
| v_I_Percentual de Desconto
| N3,2
| 443
| 448
| Percentual de desconto aplicado ao item.
|-
| Comissão
| v_I_Comissao
| N3,2
| 450
| 455
| Percentual de comissão.
|-
| Valor de Desconto
| v_I_Valor de Desconto
| N11,2
| 457
| 470
| Valor de desconto aplicado ao item.
|-
| Quantidade Original
| v_I_Quantidade Original
| N13,2
| 487
| 502
| Quantidade original do item.
|}

== Observações sobre os campos ==

* Os campos devem respeitar as posições indicadas nas colunas '''Pos. Inicial''' e '''Pos. Final'''.
* O formato '''A''' indica campo alfanumérico.
* O formato '''N''' indica campo numérico.
* O formato '''D''' indica campo de data.
* O formato '''L''' indica campo lógico.
* Campos de data devem ser informados no formato '''DD/MM/YYYY'''.
* Campos lógicos devem ser informados com '''S''' ou '''N'''.
* Campos alfanuméricos devem respeitar o tamanho definido no layout.
* Campos numéricos devem respeitar a quantidade de inteiros e decimais indicada no formato.
* Os códigos de empresa/pessoa, portador, conta financeira, material, objeto e tipo de operação devem existir no sistema quando informados no arquivo.

== Exemplos de arquivo ==

Os exemplos abaixo são ilustrativos e demonstram a estrutura esperada do arquivo. Para utilização real, os códigos de contrato, objeto, empresa/pessoa, portador, conta financeira, material e tipo de operação devem existir na base em que a importação será executada.

=== Exemplo 1 — Um contrato, uma observação, parcelas e um item ===

<pre>
C CTR00001 CONTRATO DE TESTE - IMPORTACAO EDI C A OBJ0000001 000001 000001 000001 CONTATO001 PED000001 01/07/2026 31/12/2026 10 N 31/12/2026 00000001250,00 01/07/2026 IGPM 005,00 030 002,00 000001 000002 000003 000004 000005 A 1 01 001 01 NF001 001 00000007500,00 00000007500,00 1 001 000001 S 001
O OBSERVACAO DO CONTRATO DE TESTE PARA IMPORTACAO EDI.
P 006 01 10/07/2026 01/07/2026 001 000,00 IGPM N N N N
I 0001 00001 MAT00000000000000001 ESP001 ESP002 00000010,00 ITEM DE CONTRATO IMPORTADO VIA EDI 0000001250,00000 01/07/2026 1 01/07/2026 IGPM 0001 PRODCLI000000000001 000001 S 5101A 000001 000001 01 S N 005,00 000,00 00000000062,50 0000000000010,00
</pre>

=== Exemplo 2 — Um contrato com dois itens ===

<pre>
C CTR00002 CONTRATO COM DOIS ITENS C A OBJ0000001 000001 000001 000001 CONTATO001 PED000002 01/07/2026 31/12/2026 10 N 31/12/2026 00000002000,00 01/07/2026 IGPM 000,00 030 002,00 000001 000002 000003 000004 000005 A 1 01 001 01 NF001 001 00000012000,00 00000012000,00 1 001 000001 S 001
P 006 01 10/07/2026 01/07/2026 001 000,00 IGPM N N N N
I 0001 00001 MAT00000000000000001 ESP001 ESP002 00000005,00 ITEM 01 IMPORTADO VIA EDI 0000001000,00000 01/07/2026 1 01/07/2026 IGPM 0001 PRODCLI000000000001 000001 S 5101A 000001 000001 01 S N 000,00 000,00 00000000000,00 0000000000005,00
I 0001 00002 MAT00000000000000002 ESP001 ESP002 00000003,00 ITEM 02 IMPORTADO VIA EDI 0000000500,00000 01/07/2026 1 01/07/2026 IGPM 0001 PRODCLI000000000002 000001 S 5101A 000001 000001 01 S N 000,00 000,00 00000000000,00 0000000000003,00
</pre>

== Exemplo estrutural de arquivo ==

<pre>
C <dados principais do contrato>
O <observações e descrição complementar>
P <parâmetros para geração das parcelas>
I <dados do item do contrato>
</pre>

O exemplo acima é apenas estrutural. O arquivo real deve respeitar as posições, formatos e identificadores de registro definidos neste layout.

== Validações realizadas pelo sistema ==

* Caso o arquivo informado não exista, a rotina interrompe o processamento.
* O identificador da linha deve corresponder a um tipo de registro aceito pela rotina.
* A sequência dos registros é validada conforme o tipo da linha atual e da linha anterior.
* O contrato informado não deve existir previamente no sistema.
* Os códigos de empresa/pessoa informados devem existir no cadastro.
* Os portadores informados devem existir no cadastro.
* As contas financeiras informadas devem existir no cadastro.
* O código do material informado deve existir no cadastro.
* O objeto informado deve existir no cadastro.
* O tipo de operação informado deve existir no cadastro.

== Observações técnicas ==

* A rotina utiliza arquivo texto posicional, sem delimitador.
* O tipo de registro é identificado pela primeira posição da linha.

CT EDI Contratos CIGAM

2026-06-15T16:17:52Z

Bruno.walzer: Atualização de documentação com mais exemplos, detalhes e organização da página

CT EDI Contratos CIGAM

2026-06-15T14:02:46Z

Bruno.walzer: Documentação da rotina de EDI Contratos CIGAM

[[Finanças]] > [[CT_Contratos|Contratos]] > [[CT_Rotinas|Rotinas]] > [[CT_Rotinas_EDI|EDI]] > [[CT_Rotinas_EDI_Recebe|Recebe]] > [[CT_EDI Contratos CIGAM|EDI Contratos CIGAM]]
 
Programa para importar arquivos.
 
[[Image: importacigm.png|500px|centro]]
 
== Descrição ==
A rotina '''EDI Contratos CIGAM''' (CG03294) permite importar contratos para o CIGAM a partir de um arquivo texto externo, seguindo layout posicional definido para a rotina.

Por meio do arquivo de importação, é possível informar:

* Dados principais do contrato;
* Observações e descrições complementares;
* Parâmetros para geração das parcelas;
* Itens vinculados ao contrato.

Durante o processamento, o sistema realiza validações sobre os dados informados no arquivo antes de efetivar a importação. Caso sejam identificadas inconsistências, a rotina apresenta as mensagens de erro correspondentes, permitindo a correção do arquivo antes de uma nova tentativa.

Após a validação, a rotina realiza a criação do contrato, dos itens e das parcelas conforme as informações recebidas no arquivo.

== Pré-requisito ==
Para utilizar esta rotina, é necessário que os cadastros referenciados no arquivo estejam previamente cadastrados no sistema, quando informados no layout.

Entre os principais cadastros validados pela rotina, estão:

* Empresa/Pessoa;
* Portador;
* Conta financeira;
* Código do material;
* Objeto;
* Tipo de operação.

O contrato informado no arquivo não deve existir previamente no sistema, pois a rotina realiza a validação de existência antes da importação.

== Localização no sistema ==
'''Finanças → Contratos → Rotinas → EDI → Recebe → EDI Contratos CIGAM'''

== Como utilizar ==

=== 1. Preparar o arquivo de importação ===
O arquivo deve ser texto, '''posicional (largura fixa)''', '''sem delimitador''' — os campos são identificados pela posição inicial e final de cada informação.

Cada linha do arquivo deve iniciar com um identificador de registro, responsável por indicar o tipo de informação que está sendo importada.

O arquivo pode conter diferentes tipos de registro:

== Estrutura do arquivo ==

=== Linha tipo C - Contrato ===
Registro utilizado para informar os dados principais do contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''C'''
|-
| Código do Contrato
| v_C_Contrato
| A8
| 5
| 12
| Código do contrato a ser importado. Não deve existir previamente no sistema.
|-
| Descrição do Contrato
| v_C_Descricao
| A60
| 14
| 73
| Descrição principal do contrato.
|-
| Natureza
| v_C_Natureza
| A1
| 75
| 75
| Natureza do contrato.
|-
| Tipo
| v_C_Tipo
| A1
| 77
| 77
| Tipo do contrato.
|-
| Objeto
| v_C_Objeto
| A10
| 79
| 88
| Código do objeto. Deve estar cadastrado no sistema.
|-
| Contratante
| v_C_Contratante
| A6
| 90
| 95
| Código da empresa/pessoa contratante.
|-
| Cobrança
| v_C_Cobrança
| A6
| 97
| 102
| Código da empresa/pessoa utilizada para cobrança.
|-
| Cliente
| v_C_Cliente
| A6
| 104
| 109
| Cliente vinculado ao contrato.
|-
| Contrato Repasse
| v_C_Contrato Repasse
| A8
| 111
| 118
| Informar quando aplicável.
|-
| Avalista 1
| v_C_Avalista 1
| A6
| 120
| 125
| Informar quando aplicável.
|-
| Avalista 2
| v_C_Avalista 2
| A6
| 127
| 132
| Informar quando aplicável.
|-
| Fiador
| v_C_Fiador
| A6
| 134
| 139
| Informar quando aplicável.
|-
| Contato
| v_C_Contato
| A15
| 141
| 155
| Contato relacionado ao contrato.
|-
| Pedido
| v_C_Pedido
| A12
| 157
| 168
| Pedido relacionado ao contrato, quando houver.
|-
| Vigência Inicial
| v_C_Vigencia Inicial
| D10
| 170
| 179
| Data no formato '''DD/MM/YYYY'''.
|-
| Vigência Final
| v_C_Vigencia Final
| D10
| 181
| 190
| Data no formato '''DD/MM/YYYY'''.
|-
| Dia de Vencimento
| v_C_Dia Vencimento
| N2
| 192
| 193
| Dia de vencimento das parcelas.
|-
| Renovação
| v_C_Renovacao
| L1
| 195
| 195
| Informar '''S''' ou '''N'''.
|-
| Limite Renovação
| v_C_Limite Renovacao
| D10
| 197
| 206
| Data no formato '''DD/MM/YYYY'''.
|-
| Data Renovação
| v_C_Data Renovacao
| D10
| 208
| 217
| Data no formato '''DD/MM/YYYY''', quando aplicável.
|-
| Data Cancelamento
| v_C_Data Cancelamento
| D10
| 219
| 228
| Data no formato '''DD/MM/YYYY''', quando aplicável.
|-
| Motivo Cancelamento
| v_C_Motivo Cancelamento
| A2
| 230
| 231
| Motivo de cancelamento, quando aplicável.
|-
| Valor Parcela
| v_C_Valor Parcela
| N11,2
| 233
| 246
| Valor da parcela do contrato.
|-
| Data Base
| v_C_Data_Base
| D10
| 249
| 258
| Data base para cálculo/reajuste.
|-
| Índice
| v_C_Indice
| A5
| 271
| 275
| Índice utilizado no contrato.
|-
| Juros ao Mês (%)
| v_C_Juros Mes Percentual
| N3,2
| 277
| 282
| Percentual de juros mensal.
|-
| Limite Multa em Dias
| v_C_Limite Multa Dias
| N3
| 284
| 286
| Quantidade de dias para aplicação de multa.
|-
| Percentual Multa
| v_C_Percentual Multa
| N3,2
| 288
| 293
| Percentual de multa.
|-
| Conta Financeira
| v_C_Conta
| A6
| 295
| 300
| Conta financeira principal. Deve estar cadastrada.
|-
| Conta Multa
| v_C_Conta Multa
| A6
| 302
| 307
| Conta financeira para multa.
|-
| Conta Reajuste
| v_C_Conta Reajuste
| A6
| 309
| 314
| Conta financeira para reajuste.
|-
| Conta Juros
| v_C_Conta Juros
| A6
| 316
| 321
| Conta financeira para juros.
|-
| Conta Desconto
| v_C_Conta Desconto
| A6
| 323
| 328
| Conta financeira para desconto.
|-
| Situação do Contrato
| v_C_Situacao Contrato
| A1
| 330
| 330
| Situação inicial do contrato.
|-
| Modalidade
| v_C_Modalidade
| A1
| 332
| 332
| Modalidade do contrato.
|-
| Periodicidade
| v_C_Periodicidade
| N2
| 334
| 335
| Periodicidade do contrato.
|-
| Portador Cobrança
| v_C_Portador Cobranca
| A3
| 337
| 339
| Portador de cobrança. Deve estar cadastrado.
|-
| Tipo de Pagamento
| v_C_Tipo de Pagamento
| A2
| 341
| 342
| Tipo de pagamento utilizado no contrato.
|-
| Série NF
| v_C_Serie NF
| A5
| 344
| 348
| Série de nota fiscal relacionada.
|-
| Histórico
| v_C_Historico
| A3
| 350
| 352
| Histórico financeiro/contábil relacionado.
|-
| Valor Total
| v_C_Valor Total
| N11,2
| 354
| 367
| Valor total do contrato.
|-
| Valor Total Indexado
| v_C_Valor Total Indexado
| N11,2
| 370
| 383
| Valor total indexado, quando aplicável.
|-
| Tipo Cobrança
| v_C_Tipo Cobrança
| A1
| 399
| 399
| Tipo de cobrança do contrato.
|-
| Portador Previsão
| v_C_Portador Previsao
| A3
| 417
| 419
| Portador utilizado para previsão.
|-
| Responsável
| v_C_Responsavel
| A6
| 458
| 463
| Responsável vinculado ao contrato.
|-
| Contrato Terceiro
| v_C_Contrato Terceiro
| A15
| 661
| 675
| Contrato de terceiro, quando aplicável.
|-
| Matrícula Terceiro
| v_C_Matricula Terceiro
| A15
| 677
| 691
| Matrícula de terceiro, quando aplicável.
|-
| Contrato Assinado
| v_C_Contrato Assinado
| A1
| 910
| 910
| Indica contrato assinado.
|-
| Unidade de Negócio
| v_C_Unidade Negocio
| A3
| 927
| 929
| Unidade de negócio vinculada ao contrato.
|}

=== Linha tipo O - Observações ===
Registro utilizado para complementar as informações descritivas do contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''O'''
|-
| Observação
| v_O_Observacao
| A200
| 3
| 202
| Observação geral do contrato.
|-
| Descrição do Objeto
| v_O_Descricao Objeto
| A3001
| 204
| 3204
| Descrição complementar do objeto do contrato.
|-
| Valor por Extenso
| v_O_Valor por Extenso
| A80
| 3206
| 3285
| Valor do contrato por extenso, quando aplicável.
|}

=== Linha tipo P - Parcelas ===
Registro utilizado para informar os parâmetros de geração das parcelas do contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''P'''
|-
| Quantidade de Parcelas
| v_P_Quantidade de Parcelas
| N3
| 3
| 5
| Quantidade de parcelas a serem geradas.
|-
| Periodicidade
| v_P_periodicidade
| A2
| 7
| 8
| Periodicidade de geração das parcelas.
|-
| Primeiro Vencimento
| v_P_Primeiro Vencimento
| D10
| 10
| 19
| Data no formato '''DD/MM/YYYY'''.
|-
| Primeira Data de Lançamento
| v_P_Primeira Data Lancamento
| D10
| 21
| 30
| Primeira data de lançamento.
|-
| Portador de Previsão
| v_P_Portador de Previsao
| A3
| 32
| 34
| Portador utilizado para previsão.
|-
| Desconto até Vencimento (%)
| v_P_Desconto ate Vencimento
| N3,2
| 36
| 41
| Percentual de desconto até o vencimento.
|-
| Índice
| v_P_Indice
| A5
| 43
| 47
| Índice utilizado nas parcelas.
|-
| Gerar Lançamento Retenção
| v_P_Gerar_Lancamento Retencao
| L1
| 49
| 49
| Informar '''S''' ou '''N'''.
|-
| Contabilizar Lançamento Retenção
| v_P_Contabilizar Lancamento Ret
| L1
| 51
| 51
| Informar '''S''' ou '''N'''.
|-
| Código do Imposto
| v_P_Codigo do Imposto
| A6
| 53
| 58
| Código do imposto utilizado na retenção.
|-
| Código DARF
| v_P_Codigo DARF
| A4
| 60
| 63
| Código DARF relacionado.
|-
| Histórico de Retenção
| v_P_Historico de Retencao
| A3
| 65
| 67
| Histórico utilizado na retenção.
|-
| Conta Financeira Retenção
| v_P_Conta Fin Retencao
| A6
| 69
| 74
| Conta financeira utilizada na retenção.
|-
| Portador Retenção
| v_P_Portador Retencao
| A3
| 76
| 78
| Portador utilizado para retenção.
|-
| IRRF Abaixo do Mínimo
| v_P_IRRF_Abaixo
| A1
| 80
| 80
| Indica tratamento para IRRF abaixo do mínimo.
|-
| INSS Abaixo do Mínimo
| v_P_INSS Abaixo
| A1
| 82
| 82
| Indica tratamento para INSS abaixo do mínimo.
|}

=== Linha tipo I - Itens do Contrato ===
Registro utilizado para informar os itens vinculados ao contrato.

{| class="wikitable"
! Campo
! Variável
! Formato
! Pos. Inicial
! Pos. Final
! Observação
|-
| Tipo de Registro
| v_linha
| A1
| 1
| 1
| Valor fixo: '''I'''
|-
| Número da Parcela
| v_I_Numero da Parcela
| N4
| 3
| 6
| Número da parcela relacionada ao item.
|-
| Sequência do Item
| v_I_Sequencia Item
| N5
| 8
| 12
| Sequência do item no contrato.
|-
| Código do Material
| v_I_Codigo do Material
| A20
| 14
| 33
| Código do material. Deve estar cadastrado no sistema.
|-
| Especificação 1
| v_I_Especif1
| A6
| 35
| 40
| Especificação complementar do material.
|-
| Especificação 2
| v_I_Especif2
| A6
| 42
| 47
| Especificação complementar do material.
|-
| Quantidade
| v_I_Quantidade
| N8,2
| 49
| 59
| Quantidade do item.
|-
| Descrição
| v_I_Descricao
| A201
| 61
| 261
| Descrição do item.
|-
| Preço Unitário
| v_I_Preco Unitario
| N10,5
| 263
| 278
| Preço unitário do item.
|-
| Data de Competência
| v_I_Data Competencia
| D10
| 280
| 289
| Data no formato '''DD/MM/YYYY'''.
|-
| Tipo de Parcela
| v_I_Tipo Parcela
| A1
| 291
| 291
| Tipo de parcela do item.
|-
| Data Base
| v_I_Data Base
| D10
| 293
| 302
| Data base do item.
|-
| Índice
| v_I_Indice
| A5
| 304
| 308
| Índice utilizado no item.
|-
| Repetição
| v_I_Repeticao
| N4
| 310
| 313
| Quantidade de repetições.
|-
| Código Produto Cliente
| v_I_Codigo Produto Cliente
| A20
| 315
| 334
| Código do produto utilizado pelo cliente.
|-
| Cliente
| v_I_Cliente
| A6
| 336
| 341
| Cliente relacionado ao item.
|-
| Cobrar
| v_I_Cobrar
| L1
| 343
| 343
| Informar '''S''' ou '''N'''.
|-
| Tipo de Operação
| v_I_Tipo Operacao
| A5
| 384
| 388
| Tipo de operação utilizado no item. Deve estar cadastrado.
|-
| Reduzido Gerencial
| v_I_Reduzido Gerencial
| A6
| 399
| 404
| Código reduzido gerencial.
|-
| Reduzido Contábil
| v_I_Reduzido Contabil
| A6
| 406
| 411
| Código reduzido contábil.
|-
| Periodicidade
| v_I_Periodicidade
| A2
| 419
| 420
| Periodicidade do item.
|-
| Buscar Regra Fiscal
| v_I_Buscar Regra Fiscal
| L1
| 437
| 437
| Informar '''S''' ou '''N'''.
|-
| Bloquear Alteração de Quantidade
| v_I_Bloquear Alteracao de Qt
| L1
| 439
| 439
| Informar '''S''' ou '''N'''.
|-
| Percentual de Desconto
| v_I_Percentual de Desconto
| N3,2
| 443
| 448
| Percentual de desconto aplicado ao item.
|-
| Comissão
| v_I_Comissao
| N3,2
| 450
| 455
| Percentual de comissão.
|-
| Valor de Desconto
| v_I_Valor de Desconto
| N11,2
| 457
| 470
| Valor de desconto aplicado ao item.
|-
| Quantidade Original
| v_I_Quantidade Original
| N13,2
| 487
| 502
| Quantidade original do item.
|}

== Observações sobre os campos ==

* Os campos devem respeitar as posições indicadas nas colunas '''Pos. Inicial''' e '''Pos. Final'''.
* O formato '''A''' indica campo alfanumérico.
* O formato '''N''' indica campo numérico.
* O formato '''D''' indica campo de data.
* O formato '''L''' indica campo lógico.
* Campos de data devem ser informados no formato '''DD/MM/YYYY'''.
* Campos lógicos devem ser informados com '''S''' ou '''N'''.
* Campos alfanuméricos devem respeitar o tamanho definido no layout.
* Campos numéricos devem respeitar a quantidade de inteiros e decimais indicada no formato.
* Os códigos de empresa/pessoa, portador, conta financeira, material, objeto e tipo de operação devem existir no sistema quando informados no arquivo.

== Exemplo estrutural de arquivo ==

<pre>
C <dados principais do contrato>
O <observações e descrição complementar>
P <parâmetros para geração das parcelas>
I <dados do item do contrato>
</pre>

O exemplo acima é apenas estrutural. O arquivo real deve respeitar as posições, formatos e identificadores de registro definidos neste layout.

== Validações realizadas pelo sistema ==

* Caso o arquivo informado não exista, a rotina interrompe o processamento.
* O identificador da linha deve corresponder a um tipo de registro aceito pela rotina.
* A sequência dos registros é validada conforme o tipo da linha atual e da linha anterior.
* O contrato informado não deve existir previamente no sistema.
* Os códigos de empresa/pessoa informados devem existir no cadastro.
* Os portadores informados devem existir no cadastro.
* As contas financeiras informadas devem existir no cadastro.
* O código do material informado deve existir no cadastro.
* O objeto informado deve existir no cadastro.
* O tipo de operação informado deve existir no cadastro.

== Observações técnicas ==

* A rotina utiliza arquivo texto posicional, sem delimitador.
* O tipo de registro é identificado pela primeira posição da linha.
* O campo '''Tipo de Registro''' não possui variável própria no Data View da rotina, sendo identificado pela leitura da linha importada.
* A task '''BETA''' e linhas de comentário interno da rotina não foram consideradas para composição deste layout funcional.