GF - Como Fazer - Layout SICOOB

De CIGAM WIKI


Layout e Detalhamento de Campos API

Registro de Boletos

Nº Campo JSON Descriçao do Banco Campo CIGAM Tabela Obrigatório Observações
1 numeroContrato Número que identifica o contrato do beneficiário. Número Controle GFPORTAD Opcional
2 modalidade Número que identifica a modalidade do boleto.

Domínios:
1 SIMPLES COM REGISTRO
5 CARNÊ DE PAGAMENTOS
6 INDEXADA
14 CARTÃO DE CRÉDITO

Não Tratado Não Tratado Opcional
3 numeroContaCorrente Número da Conta Corrente para crédito do boleto. Conta Número GFPORTAD Opcional
4 especieDocumento Espécie do documento. Clique aqui para acessar os domínios Não Tratado Não Tratado Opcional
5 dataEmissao Data de emissão do boleto. Data LANCAM Opcional
6 nossoNumero Número que identifica o boleto. Número Controle GFPORTAD Opcional
7 seuNumero Informar o número que identifica o boleto no sistema do beneficiário. Lançamento LANCAM Opcional Tamanho máximo 18
8 identificacaoBoletoEmpresa Destinado para uso da Empresa Cedente para identificação do Boleto Série LANCAM Opcional
9 identificacaoEmissaoBoleto Identificação de Emissão do Boleto.

Domínio:
1 - Banco Emite
2 - Cliente Emite

Série LANCAM Opcional
10 identificacaoDistribuicaoBoleto Identificação de Distribuição do Boleto.

Domínios:
1 - Banco Distribui
2 - Cliente Distribui

Não Tratado Não Tratado Opcional
11 valor Valor nominal do boleto. Saldo LANCAM Opcional
12 dataVencimento Data de vencimento do boleto. Vencimento LANCAM Opcional
13 dataLimitePagamento Data de limite para pagamento do boleto. Não Tratado Não Tratado Opcional
14 valorAbatimento Valor do abatimento. Não Tratado Não Tratado Opcional
15 tipoDesconto Informar o tipo de desconto atribuido ao boleto. Clique aqui para acessar os domínios Valor Desconto LANCAM Opcional
16 dataPrimeiroDesconto Data do primeiro desconto. Não Tratado Não Tratado Opcional
17 valorPrimeiroDesconto Valor do primeiro desconto. Valor Desconto LANCAM Opcional Deve ser informado caso a data do primeiro desconto seja preenchida.
18 dataSegundoDesconto Data do segundo desconto. Não Tratado Não Tratado Opcional
19 valorSegundoDesconto Valor do segundo desconto. Não Tratado Não Tratado Opcional Deve ser informado caso a data do segundo desconto seja preenchida.
20 dataTerceiroDesconto Data do terceiro desconto. Não Tratado Não Tratado Opcional
21 valorTerceiroDesconto Valor do terceiro desconto. Não Tratado Não Tratado Opcional Deve ser preenchido caso a data do terceiro desconto seja preenchida.
22 tipoMulta Tipo de multa a ser aplicado no boleto. Informar os valores listados abaixo.

Domínios:
0 - Isento
1 - Valor Fixo
2 - Percentual

Valor Multa LANCAM Opcional
23 dataMulta Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. Vencimento LANCAM Opcional
24 valorMulta Valor da multa. Valor Multa LANCAM Opcional Deve ser preenchido caso o campo dataMulta seja preenchido.
25 tipoJurosMora Tipo de juros de mora. Informar os valores listados abaixo.

Domínios:
2 - Taxa Mensal
3 - Isento

Não Tratado Não Tratado Opcional
26 dataJurosMora Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. Não Tratado Não Tratado Opcional
27 valorJurosMora Valor do juros de mora. Não Tratado Não Tratado Opcional Deve ser preenchido caso o campo dataJurosMora seja preenchido.
28 numeroParcela Número da parcela do boleto.Valor máximo permitido '99'. Não Tratado Não Tratado Opcional
29 aceite Identificador do aceite do boleto Não Tratado Não Tratado Opcional
30 codigoNegativacao Código de negativação do boleto. Informar os valores abaixo.

Domínios:
2 - Negativar Dias Úteis
3 - Não Negativar

Não Tratado Não Tratado Opcional
31 numeroDiasNegativacao Número de dias para negativação do boleto. Não Tratado Não Tratado Opcional Deve ser preenchido caso o campo codigoNegativacao seja igual a '2'.
32 codigoProtesto Código de protesto do boleto. Informar os valores abaixo.

Domínios:
1 - Protestar Dias Corridos
2 - Protestar Dias Úteis
3 - Não Protestar

Não Tratado Não Tratado Opcional
33 numeroDiasProtesto Número de dias para protesto do boleto. Não Tratado Não Tratado Opcional Deve ser preenchido caso o campo codigoProtesto seja '1'.
34 gerarPdf Identificador para o sistema devolver ou não o PDF do Boleto. O PDF será retornado na Base64. Não Tratado Não Tratado Opcional
35 pagador Opcional
35.1 numeroCpfCnpj CPF ou CNPJ do pagador do boleto de cobrança. Não Tratado Não Tratado Obrigatório Tamanho máximo 14
35.2 nome Nome completo do pagador do boleto de cobrança. Não Tratado Não Tratado Obrigatório Tamanho máximo 50
35.3 endereco Endereço do pagador do boleto de cobrança. Não Tratado Não Tratado Obrigatório Tamanho máximo 40
35.4 bairro Bairro do pagador do boleto de cobrança. Não Tratado Não Tratado Obrigatório Tamanho máximo 30
35.5 cidade Cidade do pagador do boleto de cobrança. Não Tratado Não Tratado Obrigatório Tamanho máximo 40
35.6 cep CEP do pagador. Não Tratado Não Tratado Obrigatório Tamanho máximo 8
35.7 uf UF do pagador. Não Tratado Não Tratado Obrigatório Tamanho máximo 2
35.8 email Não Tratado Não Tratado Opcional
36 beneficiarioFinal Não Tratado Não Tratado Opcional
36.1 numeroCpfCnpj Não Tratado Não Tratado
36.2 nome Não Tratado Não Tratado
37 mensagensInstrucao Não Tratado Não Tratado Opcional
37.1 tipoInstrucao Código adotado pela FEBRABAN para identificação do tipo de impressão da mensagem do boleto de cobrança.- 3 - Corpo de Instruções da Ficha de Compensação do Bloqueto. Não Tratado Não TratadoNão Tratado Opcional
37.2 mensagens Não Tratado Não Tratado Opcional
38 rateioCreditos Não Tratado Não Tratado Opcional
38.1 numeroBanco Número do Banco de Destino Não Tratado Não Tratado Obrigatório
38.2 numeroAgencia Número da Agência de Destino Não Tratado Não Tratado Obrigatório
38.3 numeroContaCorrente Número da Conta Corrente Destino. Conta Numero GFPORTAD Obrigatório
38.4 contaPrincipal Identificador de conta principal. Não Tratado Não Tratado Obrigatório
38.5 codigoTipoValorRateio Tipo de valor do Rateio.

Domínios:
1 - Percentual
2 - Valor ou Quantidade

Não Tratado Não Tratado Obrigatório
38.6 valorRateio Valor do rateio. Não Tratado Não Tratado Obrigatório
38.7 codigoTipoCalculoRateio Tipo de cálculo do Rateio.

Domínios: 1 - Valor Cobrado 2 - Valor Registro 3 - Rateio pelo menor valor

Não Tratado Não Tratado Obrigatório
38.8 numeroCpfCnpjTitular CPF ou CNPJ do titular da conta. Não Tratado Não Tratado Obrigatório Tamanho máximo 14
38.9 nomeTitular Nome completo do titular da conta. Não Tratado Não Tratado Obrigatório Tamanho máximo 50
38.10 codigoFinalidadeTed Código da Finalidade TED. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado Obrigatório
38.11 codigoTipoContaDestinoTed Tipo de conta Finalidade TED.

Domínios:
CC - Conta Corrente
CD - Conta de Depósito
CG - Conta garantida

Não Tratado Não Tratado Obrigatório Tamanho máximo 2
38.12 quantidadeDiasFloat Quantidade de dias float Não Tratado Não Tratado Obrigatório Não informar junto com dataFloatCredito
38.13 dataFloatCredito Data do float Não Tratado Não Tratado Opcional Não informar junto com quantidadeDiasFloat


Domínios: especieDocumento

• CH - Cheque
• DM - Duplicata Mercantil
• DMI - Duplicata Mercantil Indicação
• DS - Duplicata de Serviço
• DSI - Duplicata Serviço Indicação
• DR - Duplicata Rural
• LC - Letra de Câmbio
• NCC - Nota de Crédito Comercial
• NCE - Nota de Crédito Exportação
• NCI - Nota de Crédito Industrial
• NCR - Nota de Crédito Rural
• NP - Nota Promissória
• NPR - Nota Promissória Rural
• TM - Triplicata Mercantil
• TS - Triplicata de Serviço
• NS - Nota de Seguro
• RC - Recibo
• FAT - Fatura
• ND - Nota de Débito
• AP - Apólice de Seguro
• ME - Mensalidade Escolar
• PC - Pagamento de Consórcio
• NF - Nota Fiscal
• DD - Documento de Dívida
• CC - Cartão de Crédito
• BDP - Boleto Proposta
• OU - Outros

Domínios: tipoDesconto

• 0 - Sem Desconto
• 1 - Valor Fixo Até a Data Informada
• 2 - Percentual até a data informada
• 3 - Valor por antecipação dia corrido
• 4 - Valor por antecipação dia útil
• 5 - Percentual por antecipação dia corrido
• 6 - Percentual por antecipação dia útil

Domínios: codigoFinalidadeTed

• 1 - Pagamento de Impostos, Tributos e Taxas
• 2 - Pagamento à Concessionárias de Serviço Público
• 3 - Pagamentos de Dividendos
• 4 - Pagamento de Salários
• 5 - Pagamento de Fornecedores
• 6 - Pagamento de Honorários
• 7 - Pagamento de Aluguéis e Taxas de Condomínio
• 8 - Pagamento de Duplicatas e Títulos
• 9 - Pagamento de Mensalidade Escolar
• 10 - Crédito em Conta
• 99999 - Outros

Retorno de Boletos

Nº Campo JSON Descriçao do Banco Campo CIGAM Tabela Obrigatório Observações
1 resultado
2 numeroContrato Número que identifica o contrato do beneficiário. Número Controle GFPORTAD Opcional
3 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios Não Tratado Não Tratado Opcional
4 numeroContaCorrente Número da Conta Corrente para crédito do boleto. Conta Número GFPORTAD Opcional
5 especieDocumento Espécie do documento. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado Opcional
6 dataEmissao Data de emissão do boleto Data LANCAM Opcional
7 nossoNumero Número que identifica o boleto. Número Controle GFPORTAD Opcional
8 seuNumero Informar o número que identifica o boleto no sistema do beneficiário. Lancamento LANCAM Opcional Tamanho máximo 18
9 identificacaoBoletoEmpresa Destinado para uso da Empresa Cedente para identificação do Boleto. Serie LANCAM Opcional
10 codigoBarras Número de código de barras do boleto com 44 posições. Não Tratado Não Tratado Opcional
11 linhaDigitavel Número da linha digitável do boleto com 47 posições. Não Tratado Não Tratado Opcional
12 valor Valor nominal do boleto. Saldo LANCAM Opcional
13 dataVencimento Data de vencimento do boleto. Vencimento LANCAM Opcional
14 valorAbatimento Valor do abatimento. Não Tratado Não Tratado Opcional
15 tipoDesconto Informar o tipo de desconto a ser aplicado no boleto. Valor Desconto LANCAM Opcional
16 dataPrimeiroDesconto Data do primeiro desconto. Vencimento LANCAM Opcional
17 valorPrimeiroDesconto Valor do primeiro desconto Valor Desconto LANCAM Opcional
18 dataSegundoDesconto Data do segundo desconto Não Tratado Não Tratado Opcional
19 valorSegundoDesconto Valor do segundo desconto. Não Tratado Não Tratado Opcional
20 dataTerceiroDesconto Data do terceiro desconto. Não Tratado Não Tratado Opcional
21 valorTerceiroDesconto Valor do terceiro desconto. Não Tratado Não Tratado Opcional
22 tipoMulta Tipo de Multa.

Domínio:
0 - Isento
1 - Valor Fixo
2 - Percentual

Valor Multa LANCAM Opcional
23 dataMulta Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. Tolerâcia Multa LANCAM Opcional
24 valorMulta Valor da multa. Valor Multa LANCAM Opcional
25 tipoJurosMora Tipo de Juros de Mora.

Domínios:
2 - Taxa Mensal
3 - Isento

Não Tratado Não Tratado Opcional
26 dataJurosMora Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. Não Tratado Não Tratado Opcional
27 valorJurosMora Valor do Juros de Mora. Não Tratado Não Tratado Opcional
28 numeroParcela Número da parcela. Não Tratado Não Tratado Opcional
29 aceite Identificador do aceite do boleto. Não Tratado Não Tratado Opcional
30 codigoNegativacao Código de Negativação do Boleto

Domínios:
2 - Negativar Dias Úteis
3 - Não Negativar

Não Tratado Não Tratado Opcional
31 codigoProtesto Código de Protesto do Boleto

Domínios: 1 - Protestar Dias Corridos
2 - Protestar Dias Úteis
3 - Não Protestar

Não Tratado Não Tratado Opcional
32 quantidadeDiasFloat Quantidade de Dias de Float. Não Tratado Não Tratado Opcional
33 situacaoBoleto Descreve a Situação atual do Boleto. Não Tratado Não Tratado Opcional
34 pagador Opcional
34.1 numeroCpfCnpj CPF ou CNPJ do pagador. Não Tratado Não Tratado Opcional Tamanho máximo 14
34.2 nome Nome completo do pagador. Não Tratado Não Tratado Opcional Tamanho máximo 50
35 beneficiarioFinal Não Tratado Não Tratado Opcional
35.1 nome Nome do Beneficário Final. Antigo Sacador Avalista. Não Tratado Não Tratado Opcional Tamanho máximo 50
36 mensagensInstrucao Não Tratado Não Tratado Opcional
36.1 mensagens Não Tratado Não Tratado Opcional


Domínios: modalidade

• 1 - SIMPLES COM REGISTRO
• 5 - CARNÊ DE PAGAMENTOS
• 6 - INDEXADA
• 14 - CARTÃO DE CRÉDITO

Domínios: especieDocumento

• CH - Cheque
• DM - Duplicata Mercantil
• DMI - Duplicata Mercantil Indicação
• DS - Duplicata de Serviço
• DSI - Duplicata Serviço Indicação
• DR - Duplicata Rural
• LC - Letra de Câmbio
• NCC - Nota de Crédito Comercial
• NCE - Nota de Crédito Exportação
• NCI - Nota de Crédito Industrial
• NCR - Nota de Crédito Rural
• NP - Nota Promissória
• NPR - Nota Promissória Rural
• TM - Triplicata Mercantil
• TS - Triplicata de Serviço
• NS - Nota de Seguro
• RC - Recibo
• FAT - Fatura
• ND - Nota de Débito
• AP - Apólice de Seguro
• ME - Mensalidade Escolar
• PC - Pagamento de Consórcio
• NF - Nota Fiscal
• DD - Documento de Dívida
• CC - Cartão de Crédito
• BDP - Boleto Proposta
• OU - Outros

Alteração de Boletos

Nº Campo JSON Descriçao do Banco Campo CIGAM Tabela Obrigatório Observações
1 Desconto
1.1 numeroContrato Número que identifica o contrato do beneficiário. Número Controle GFPORTAD Obrigatório
1.2 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado Obrigatório
1.3 nossoNumero Número identificador do boleto. Número Controle GFPORTAD Obrigatório
1.4 tipoDesconto Informar o tipo de desconto atribuido ao boleto. Clique aqui para visualizar os Domínios. Valor Desconto LANCAM Opcional
1.5 dataPrimeiroDesconto Data do primeiro desconto. Valor Desconto LANCAM Opcional
1.6 valorPrimeiroDesconto Valor do primeiro desconto. Valor Desconto LANCAM Opcional
1.7 dataSegundoDesconto Data do segundo desconto. Não Tratado Não Tratado Opcional
1.8 valorSegundoDesconto Valor do segundo desconto. Não Tratado Não Tratado Opcional
1.9 dataTerceiroDesconto Data do terceiro desconto. Não Tratado Não Tratado Opcional
1.10 valorTerceiroDesconto Valor do terceiro desconto. Não Tratado Não Tratado Opcional
2 Abatimento
2.1 numeroContrato Número que identifica o contrato do beneficiáriono Sisbr. Número Controle GFPORTAD Opcional
2.2 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado
2.3 nossoNumero Número identificador do boleto no Sisbr. Número Controle GFPORTAD
2.4 valorAbatimento Valor do abatimento. Não Tratado Não Tratado
3 EncargoMulta
3.1 numeroContrato Número que identifica o contrato do beneficiário. Número Controle GFPORTAD
3.2 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado
3.3 nossoNumero Número identificador o boleto. Número Controle GFPORTAD
3.4 tipoMulta Tipo de Multa.

Domínios
0 - Isento
1 - Valor Fixo
2 - Percentual

Valor Multa LANCAM
3.5 dataMulta Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. Tolerância Multa LANCAM Opcional
3.6 valorMulta Valor da multa. Valor Multa LANCAM Opcional
4 EncargoJuros
4.1 numeroContrato Número que identifica o contrato do beneficiário. Número Controle GFPORTAD
4.2 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado
4.3 nossoNumero Número identificador o boleto. Número Controle GFPORTAD
4.4 tipoJurosMora Tipo de Juros de Mora.

Domínios:
2 - Taxa Mensal
3 - Isento

Não Tratado Não Tratado
4.5 dataJurosMora Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. Não Tratado Não Tratado Opcional
4.6 valorJurosMora Valor do Juros de Mora. Não Tratado Não Tratado Opcional
5 ValorNominal
5.1 numeroContrato Número que identifica o contrato do beneficiário no Sisbr. Número Controle GFPORTAD
5.2 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado
5.3 nossoNumero Número identificador o boleto no Sisbr. Número Controle GFPORTAD
5.4 valor Valor do boleto. Saldo LANCAM
6 SeuNumero
6.1 numeroContrato Número que identifica o contrato do beneficiário no Sisbr. Número Controle GFPORTAD
6.2 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado
6.3 nossoNumero Número que identifica o boleto no Sisbr. Número Controle GFPORTAD
6.4 seuNumero Número identificador do boleto determinado pelo beneficiário. Não Tratado Não Tratado Opcional Tamanho máximo 18
6.5 identificacaoBoletoEmpresa Número de controle do boleto determinado pelo beneficiário. Serie LANCAM Opcional
7 EspecieDocumento
7.1 numeroContrato Número que identifica o contrato do beneficiário no Sisbr. Número Controle GFPORTAD
7.2 modalidade Número que identifica a modalidade do boleto. Clique aqui para visualizar os Domínios. Não Tratado Não Tratado
7.3 nossoNumero Número que identifica o boleto de cobrança no Sisbr. Número Controle GFPORTAD
7.4 especieDocumento Espécie do Documento. Clique aqui para visualizar os Domínios Não Tratado Não Tratado

Domínios: modalidade

• 1 - SIMPLES COM REGISTRO
• 5 - CARNÊ DE PAGAMENTOS
• 6 - INDEXADA
• 14 - CARTÃO DE CRÉDITO

Domínios: tipoDesconto

• 0 - Sem Desconto
• 1 - Valor Fixo Até a Data Informada
• 2 - Percentual até a data informada
• 3 - Valor por antecipação dia corrido
• 4 - Valor por antecipação dia útil
• 5 - Percentual por antecipação dia corrido
• 6 - Percentual por antecipação dia útil

Domínios: especieDocumento

• CH - Cheque
• DM - Duplicata Mercantil
• DMI - Duplicata Mercantil Indicação
• DS - Duplicata de Serviço
• DSI - Duplicata Serviço Indicação
• DR - Duplicata Rural
• LC - Letra de Câmbio
• NCC - Nota de Crédito Comercial
• NCE - Nota de Crédito Exportação
• NCI - Nota de Crédito Industrial
• NCR - Nota de Crédito Rural
• NP - Nota Promissória
• NPR - Nota Promissória Rural
• TM - Triplicata Mercantil
• TS - Triplicata de Serviço
• NS - Nota de Seguro
• RC - Recibo
• FAT - Fatura
• ND - Nota de Débito
• AP - Apólice de Seguro
• ME - Mensalidade Escolar
• PC - Pagamento de Consórcio
• NF - Nota Fiscal
• DD - Documento de Dívida
• CC - Cartão de Crédito
• BDP - Boleto Proposta
• OU - Outros

Disponível em "https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Layout_SICOOB&oldid=86158"