GF - Como Fazer - Layout SICREDI

Layout e Detalhamento de Campos API

Registro de Boletos

Nº	Campo JSON	Descriçao do Banco	Campo CIGAM	Tabela	Obrigatório	Observações
1	token	Chave Transacional gerada pelo recurso /autenticacao			Obrigatório
2	Content-Type	Estabelece o tipo de conteúdo da requisição			Obrigatório
3	agencia	Código da Cooperativa do beneficiário	Agência	Portador	Obrigatório
4	posto	Código do Posto do beneficiário	Dígito Agência	Portador	Obrigatório
5	cedente	Código do Convênio de Cobrança do beneficiário	Código Cedente	Portador	Obrigatório
6	nossoNumero*	Nosso Número	Nosso Número	Boletos	Opcional
7	codigoPagador	Código Pagador	Não Tratado	Não Tratado	Opcional
8	tipoPessoa*	Tipo de pessoa do pagador. Domínio: 1 - PESSOA FÍSICA 2 - PESSOA JURÍDICA	Pessoa	Empresa	Obrigatório
9	cpfCnpj*	CPF ou CNPJ do pagador	CNPJ/CPF	Empresa	Obrigatório
10	nome	Nome do pagador	Nome Completo	Empresa	Obrigatório
11	endereco	Endereço do pagador	Endereço	Empresa	Opcional	Será obrigatório se o código do pagador não for informado.
12	cidade	cidade	Município	Empresa	Opcional	Será obrigatório se o código do pagador não for informado.
13	uf	Estado do pagador	UF	Empresa	Opcional	Será obrigatório se o código do pagador não for informado.
14	cep	CEP do pagador	CEP	Empresa	Obrigatório
15	telefone	Telefone mais DDD do pagador	Fone	Empresa	Opcional	Será obrigatório se o código do pagador não for informado.
16	email	Endereço de email do pagador	Email	Contato	Opcional
17	especieDocumento	Espécie de documento do título.(*)	Espécie	Portador	Obrigatório
18	codigoSacadorAvalista	Código do sacador avalista.	Não Tradado	Não Tradado	Opcional
19	seuNumero	Número de controle interno do beneficiário que referencia o pagador.	Lançamento	LANCAM	Obrigatório
20	dataVencimento	Data de vencimento do boleto	Vencimento	Boletos	Obrigatório
21	valor	Valor do boleto	Saldo	LANCAM	Obrigatório
22	tipoDesconto	Tipo de desconto. Domínios: A - VALOR B - PERCENTUAL	Não Tratado	Não Tratado	Obrigatório
23	valorDesconto1	Valor de desconto 1	Valor Desconto	LANCAM	Opcional	Será obrigatório se o dataDesconto1 for informado.
24	dataDesconto1	Data limite para concessão de desconto1	Vencimento	LANCAM	Opcional	Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
25	valorDesconto2	Valor de desconto 2	Não Tratado	Não Tratado	Opcional	Será obrigatório se o dataDesconto2 for informado.
26	dataDesconto2	Data limite para a concessão de desconto 2	Não Tratado	Não Tratado	Opcional	Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
27	valorDesconto3	Valor de desconto 3	Não Tratado	Não Tratado	Opcional	Será obrigatório se o dataDesconto3 for informado.
28	dataDesconto3	Data limite para a concessão de desconto 3	Não Tratado	Não Tratado	Opcional	Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
29	tipoJuros	Tipo de Juros. Domínios: A - VALOR B - PERCENTUAL			Obrigatório
30	juros	Valor de juros a cobrar por dia.	Juros Dia	LANCAM	Opcional
31	multas	Percentual de multa a cobrar	Valor Multa	LANCAM	Opcional
32	desconto Antecipado	Valor de desconto antecipado a cobrar	Não Tratado	Não Tratado	Opcional	Deve ser menor que o valor.
33	informativo	Texto do Informativo	Não Tratado	Não Tratado	Opcional
34	mensagem*	Texto da linha da mensagem	Não Tratado	Não Tratado	Opcional
35	codigoMensagem	Código da mensagem	Não Tratado	Não Tratado	Opcional
36	numDiasNegativacaoAuto	Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento.	Protesto	Portador	Opcional
37	NomeBeneficiarioFinal	NomeBeneficiarioFinal	Não Tratado	Não Tratado	Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal
38	TipoPessoaBeneficiarioFinal	Tipo de pessoa. Domínios: 1 - Física 2 - Jurídica	Não Tratado	Não Tratado	Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal
39	CpfCnpjBeneficiarioFinal	CPF/CNPJ do beneficiário final	Não Tratado	Não Tratado	Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal
40	FoneBeneficiarioFinal	Fone do beneficiário final	Não Tratado	Não Tratado	Opcional
41	EnderecoBeneficiarioFinal	Endereço do beneficiário final	Não Tratado	Não Tratado	Opcional
42	CepBeneficiarioFinal	CEP do beneficiário final	Não Tratado	Não Tratado	Opcional
43	CidadeBeneficiarioFinal	CidadeBeneficiarioFinal	Não Tratado	Não Tratado	Opcional
44	UfBeneficiarioFinal	UF do beneficiário final	Não Tratado	Não Tratado	Opcional

(*) Domínios:
A - DUPLICATA MERCANTIL (DM)
B - DUPLICATA RURAL (DR)
C - NOTA PROMISSORIA (NP)
D - NOTA PROMISSORIA RURAL (NR)
E - NOTA DE SEGURO (NS)
G - RECIBO (RC)
H - LETRA DE CAMBIO (LC)
I - NOTA DE DEBITO (ND)
J - DUPLICATA DE SERVICO (DS)
K - OUTROS (OS)
O - BOLETO OFERTA (OFE)

Alteração de Boletos

Nº	Campo JSON	Descriçao do Banco	Campo CIGAM	Tabela	Obrigatório	Observações
1	agencia	Agência do Beneficiário	Agência	Portador	Obrigatório
2	posto	Posto do Beneficiário	Dígito Agência	Portador	Obrigatório
3	cedente	Código do Beneficiário	Código Cedente	Portador	Obrigatório
4	nossoNumero*	Nosso Número do Título	Nosso Número	Boletos	Obrigatório
5	instrucaoComando	Comando que será realizado na alteração do boleto.			Obrigatório	Caso seja informado ALTERACAO_OUTROS_DADOS será obrigatória a inclusão do campo complementoInstrucao.
5.1	PEDIDO_BAIXA				Obrigatório	Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
5.2	CONCESSAO_ABATIMENTO				Obrigatório
5.3	CANCELAMENTO_ABATIMENTO_CONCEDIDO				Obrigatório
5.4	ALTERACAO_VENCIMENTO				Obrigatório
5.5	ALTERACAO_SEU_NUMERO				Obrigatório
5.6	PEDIDO_PROTESTO				Obrigatório	Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
5.7	SUSTAR_PROTESTO_BAIXAR _TITULO				Obrigatório
5.8	SUSTAR_PROTESTO_MANTER_CARTEIRA				Obrigatório
5.9	ALTERACAO_OUTROS_DADOS				Obrigatório
6	complementoInstrucao	Complemento do comando que será realizado na alteração do boleto			Condicional
6.1	DESCONTO				Condicional
6.2	JUROS_DIA				Condicional
6.3	DESCONTO_DIA_ANTECIPACAO				Condicional
6.4	DATA_LIMITE_CONCESSAO_DESCONTO				Condicional
6.5	CANCELAMENTO_PROTESTO _AUTOMATICO				Condicional
6.6	CANCELAMENTO_NEGATIVACAO_AUTOMATICA				Condicional
7	Campo de Alteração	Nome do campo que deseja mudar			Obrigatório