Linha RM

Atalhos

Páginas filhas
  • Registro online SICOOB

Conteúdo:

      1. Registro online

Este recurso tem como objetivo preparar o TOTVS Gestão Financeira para utilizar o serviço de registro online da carteira de cobrança registrada do Banco SICOOB.

      2. Procedimento para configuração

Através do cadastro do Convênio, localizado no menu 'Movimentações Bancárias', é necessário habilitar a opção "Permite registro de boleto online" e definir os parâmetros de acordo com os dados fornecidos pelo banco Sicoob. O TOTVS Gestão Financeira disponibiliza três modelos de registro:


    • URL do serviço de registro do boleto: Deve ser informada a URL do serviço de registro do boleto disponibilizada pelo Banco
    • URL do sistema autorizador: Deve ser informada a URL do serviço de autorização disponibilizado pelo Banco
    • Client Id e Client Secret: Código do sistema de autorização fornecido pelo Banco
    • URL de Callback: URL de Callback que deve ser informada na geração do código de autorização, onde o mesmo será exibido. (http://[servidor]/Corpore.Net/Source/Fin-Financeiro/RM.Fin.Banco/SicoobCallback.aspx) 
    • Código de autorização: Código de acesso do sistema de autorização para criação de tokens. Deve ser gerada no portal do Banco.

    Importante:

    • O campo "Refresh token" está disponível apenas no modelo de registro online "v1". Ao ser gerado o código de autorização e informado no cadastro do convênio, deve ser obtido o refresh token clicando no botão. Esse refresh token será usado para obter o acess token necessário para registro do boleto no banco. Somente é preciso obter o refresh token uma vez
    • O código de autorização expira em 5 minutos, ou seja, o mesmo deve ser utilizado nesse tempo para obter o refresh token       


            Exemplo de geração do código de autorização.

    A URL para gerar o código de autorização tem o seguinte formato:

    https://api.sisbr.com.br/auth/oauth2/authorize?response_type=code&redirect_uri=[[callback_url]]&client_id=[[client_id]]&versaoHash=3&scope=[[escopos]], onde

    [[callback_url]] = URL de callback informada no convênio

    [[client_id]] = client id informado no convênio

    [[escopos]] = cobranca_boletos_incluir


                                                               


    • URL do serviço de registro do boleto: Deve ser informada a URL do serviço de registro do boleto disponibilizada pelo Banco
    • URL do sistema autorizador: Deve ser informada a URL do serviço de autorização disponibilizado pelo Banco
    • Client Id : Código do sistema de autorização fornecido pelo Banco
    • Certificado digital: Certificado digital cadastrado junto ao Banco para o registro de boleto online.

    Importante:

    • O Modelo de registro online "v2" está disponível a partir do patch 12.1.2302.152.
    • Informações de como gerar o certificado é necessário verificar as instruções disponíveis na documentação da API. Dúvidas a respeito, recomendamos entrar em contato com o suporte do Banco.

    https://developers.sicoob.com.br/portal/documentacao?slugItem=apis-do-sicoob&slugSubItem=primeiros-passos

    https://developers.sicoob.com.br/portal/documentacao?slugItem=seguranca&slugSubItem=certificado-digital

    Notas:

    • Se no lançamento financeiro o campo 'Multa' for maior que 0 (zero), a tag tipoMulta será preenchida com o valor "1". Do contrário, se multa ao dia for maior que 0 (zero), a tag será preenchida com o valor "2". Por último, quando ambos 0 (zero), esta tag será preenchida com o valor "0"
    • Para os dois primeiros casos a tag dataMulta será preenchida com a data de vencimento acrescida do campo "Dias atraso multa". No último caso, será preenchida com valor nulo.
    • Códigos da Multa, segundo o Sicoob: 

             '0' = Isento 
             '1' = Valor Fixo 
             '2' = Percentual

    • Se no lançamento financeiro o valor de juros ao dia for maior que 0 (zero) e o tipo de juros ao dia como "Valor", a tag tipoJurosMora será gerada com o valor "1". Caso contrário, se o campo 'Juros' for maior que 0 (zero), a tag será preenchida com o valor "2". Por último, se ambos valores de juros for igual a 0 (zero) esta tag será preenchida com o valor "0"
    • Para os dois primeiros casos a tag dataJurosMora será preenchida com a data de vencimento acrescida da carência de juros (campo do lançamento financeiro). No último caso, será preenchida com valor nulo.
    • Código do Juros de Mora, segundo o SICOOB: 

             '0' = Isento 
             '1' = Valor por Dia 
             '2' = Taxa Mensal 

    Conforme detalhado no item 3 deste documento, é possível customizar o dado a ser enviado no registro online. Abaixo, seguem alguns exemplos de cadastro de campo no layout do registro online:

    Campo da seção principal:

    • numeroContrato

    • modalidade

    • numeroContaCorrente

    • especieDocumento

    • dataEmissao

    • nossoNumero

    • seuNumero

    • identificacaoBoletoEmpresa

    • identificacaoEmissaoBoleto

    • identificacaoDistribuicaoBoleto

    • valor

    • dataVencimento

    • dataLimitePagamento

    • valorAbatimento

    • tipoDesconto

    • dataPrimeiroDesconto

    • valorPrimeiroDesconto

    • dataSegundoDesconto

    • valorSegundoDesconto

    • dataTerceiroDesconto

    • valorTerceiroDesconto

    • tipoMulta

    • dataMulta

    • valorMulta

    • tipoJurosMora

    • dataJurosMora

    • valorJurosMora

    • numeroParcela

    • aceite

    • codigoNegativacao

    • numeroDiasNegativacao

    • codigoProtesto

    • numeroDiasProtesto

                                                                     

    Campo da seção "pagador":

    • pagador.numeroCpfCnpj

    • pagador.nome

    • pagador.endereco

    • pagador.bairro

    • pagador.cidade

    • pagador.cep

    • pagador.uf

                                                                   

    Campo da seção "beneficiarioFinal":

    • beneficiarioFinal.numeroCpfCnpj

    • beneficiarioFinal.nome

                                                                   

    Campo da seção grupo de "mensagensInstrucao":

    • tipoInstrucao
    • mensagensInstrucao.mensagens1
    • mensagensInstrucao.mensagens2
    • mensagensInstrucao.mensagens3
    • mensagensInstrucao.mensagens4
    • mensagensInstrucao.mensagens5

                                                                   


                                                                


    • URL do serviço de registro do boleto: Deve ser informada a URL do serviço de registro do boleto disponibilizada pelo Banco
    • URL do sistema autorizador: Deve ser informada a URL do serviço de autorização disponibilizado pelo Banco
    • Client Id : Código do sistema de autorização fornecido pelo Banco
    • Certificado digital: Certificado digital cadastrado junto ao Banco para o registro de boleto online.

    Importante:

    • O Modelo de registro online "v3" está disponível a partir das versões:
      • 12.1.2502.127
      • 12.1.2410.209
      • 12.1.2406.262
    • Informações de como gerar o certificado é necessário verificar as instruções disponíveis na documentação da API. Dúvidas a respeito, recomendamos entrar em contato com o suporte do Banco.

    https://developers.sicoob.com.br/portal/documentacao?slugItem=apis-do-sicoob&slugSubItem=primeiros-passos

    https://developers.sicoob.com.br/portal/documentacao?slugItem=seguranca&slugSubItem=certificado-digital

    Notas:

    • Se no lançamento financeiro o campo 'Multa' for maior que 0 (zero), a tag tipoMulta será preenchida com o valor "1". Do contrário, se multa ao dia for maior que 0 (zero), a tag será preenchida com o valor "2". Por último, quando ambos 0 (zero), esta tag será preenchida com o valor "0"
    • Para os dois primeiros casos a tag dataMulta será preenchida com a data de vencimento acrescida do campo "Dias atraso multa". No último caso, será preenchida com valor nulo.
    • Códigos da Multa, segundo o Sicoob: 

             '0' = Isento 
             '1' = Valor Fixo 
             '2' = Percentual

    • Se no lançamento financeiro o valor de juros ao dia for maior que 0 (zero) e o tipo de juros ao dia como "Valor", a tag tipoJurosMora será gerada com o valor "1". Caso contrário, se o campo 'Juros' for maior que 0 (zero), a tag será preenchida com o valor "2". Por último, se ambos valores de juros for igual a 0 (zero) esta tag será preenchida com o valor "0"
    • Para os dois primeiros casos a tag dataJurosMora será preenchida com a data de vencimento acrescida da carência de juros (campo do lançamento financeiro). No último caso, será preenchida com valor nulo.
    • Código do Juros de Mora, segundo o SICOOB: 

             '0' = Isento 
             '1' = Valor por Dia 
             '2' = Taxa Mensal 

    Conforme detalhado no item 3 deste documento, é possível customizar o dado a ser enviado no registro online. Abaixo, seguem alguns exemplos de cadastro de campo no layout do registro online:

    Campo da seção principal:

    • numeroCliente

    • codigoModalidade

    • numeroContaCorrente

    • codigoEspecieDocumento

    • dataEmissao

    • nossoNumero

    • seuNumero

    • identificacaoBoletoEmpresa

    • codigoBarras

    • linhaDigitavel

    • identificacaoEmissaoBoleto

    • identificacaoDistribuicaoBoleto

    • valor

    • dataVencimento

    • dataLimitePagamento

    • valorAbatimento

    • tipoDesconto

    • dataPrimeiroDesconto

    • valorPrimeiroDesconto

    • dataSegundoDesconto

    • valorSegundoDesconto

    • dataTerceiroDesconto

    • valorTerceiroDesconto

    • tipoMulta

    • dataMulta

    • valorMulta

    • tipoJurosMora

    • dataJurosMora

    • valorJurosMora

    • numeroParcela

    • aceite

    • codigoNegativacao

    • numeroDiasNegativacao

    • codigoProtesto

    • numeroDiasProtesto

    • quantidadeDiasFloat

                                                                     

    Campo da seção "pagador":

    • pagador.numeroCpfCnpj

    • pagador.nome

    • pagador.endereco

    • pagador.bairro

    • pagador.cidade

    • pagador.cep

    • pagador.uf

    • pagador.email

                                                                     

    Campo da seção "beneficiarioFinal":

    • beneficiarioFinal.numeroCpfCnpj

    • beneficiarioFinal.nome
                                                             

    Campo da seção grupo de "mensagensInstrucao":

    • mensagensInstrucao1
    • mensagensInstrucao2
    • mensagensInstrucao3
    • mensagensInstrucao4
    • mensagensInstrucao5

                                                                       


          3. Customização de dados no registro online


    Pode ser utilizado o Cadastro de Layout do Registro Online, para enviar dados de forma flexível para o registro online dos boletos para o banco. Para isso deve ser feito o Cadastro de associação de fórmulas e campos do registro online no cadastro do convênio.

    O cadastro do layout do registro online do Sicoob deve ser realizado de acordo com o manual de cobrança online do banco. Ressaltamos que o layout da v1 é totalmente diferente da v2 e v3, então o cadastro de layout de registro online deve ser refeito na migração da v1 para v2 ou v3. Demonstramos alguns exemplos de campos nas guias referente a cada modelo de registro online (item 2).