1 153
edições
Mudanças
Adicionado __NOTITLE__
__NOTITLE__
<big>'''E-Boleto - Sistema emissor de boletos eletrônicos.'''</big>
==Realizando a emissão de um boleto==
===Definição das Entendendo as propriedades de envio===
Antes de iniciarmos com os exemplos. Verifique as definições dos campos para o envio dos boletos.
<table border=1 cellpadding=0 cellspacing=0 style='width: 800px;border-collapse: collapse;'>
<tr>
<th>NomeNomePagador</th>
<th>Tipo</th>
<th>Descrição</th>
</tr>
<tr>
<td style="text-align: left;">cedenteCodigoCedente</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Código do Convênio de Cobrança do beneficiário</td>
<td style="text-align: left;">tipoPessoa</td>
<td style="text-align: left;">Domínios:
<br/>0
<br/>1
</td>
<td style="text-align: left;">Tipo de pessoa do pagador, podendo ser:
<br/>1 0 - PESSOA FISICA <br/>2 1 - PESSOA JURIDICA
</td>
<td style="text-align: left;">Obrigatório</td>
</tr>
<tr>
<td style="text-align: left;">nomenomePagador</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Nome do pagador </td>
</tr>
<tr>
<td style="text-align: left;">enderecoEnderecoPagador</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Endereço do pagador</td>
<td style="text-align: left;">especieDocumento</td>
<td style="text-align: left;">Domínios:
<br/>A0 <br/>B1 <br/>C2 <br/>D3 <br/>E4 <br/>G5 <br/>H6 <br/>I7 <br/>J8 <br/>K9 <br/>O10
</td>
<td style="text-align: left;">Espécie de documento do título,</td>
<td style="text-align: left;">Obrigatório
<br/>Podendo ser:
<br/>A 0 - DUPLICATA MERCANTIL (DM) <br/>B 1 - DUPLICATA RURAL (DR) <br/>C 2 - NOTA PROMISSOR IA (NP) <br/>D 3 - NOTA PROMISSOR IA RURAL (NR) <br/>E 4 - NOTA DE SEGURO (NS) <br/>G 5 - RECIBO (RC) <br/>H 6 - LETRA DE CAMBIO (LC) <br/>I 7 - NOTA DE DEBITO (ND) <br/>J 8 - DUPLICATA DE SERVICO (DS) <br/>K 9 - OUTROS (OS) <br/>O 10 - BOLETO OFERTA (OFE)
</td>
</tr>
<tr>
<td style="text-align: left;">codigoSacador Avalista </td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">tipoDesconto</td>
<td style="text-align: left;">Domínios:
<br/>A 0 <br/>B1
</td>
<td style="text-align: left;">Tipo de desconto, podendo ser:
<br/>A 0 - VALOR <br/>B 1 - PERCENTUAL
</td>
<td style="text-align: left;">Obrigatório</td>
<td style="text-align: left;">tipoJuros</td>
<td style="text-align: left;">Domínios:
<br/>A 0 <br/>B1
</td>
<td style="text-align: left;">Tipo de Juros, podendo ser:
<br/>A 0 - VALOR <br/>B 1 - PERCENTUAL
</td>
<td style="text-align: left;">Obrigatório</td>
<td style="text-align: left;">Opcional</td>
</tr></table>
</div>
===Entendendo as propriedades de retorno===
<div class="center">
<table border=1 cellpadding=0 cellspacing=0 style='border-collapse: collapse;width:800px'>
<tr>
<th style="text-align: left;">NomePagador</th>
<th style="text-align: left;">Tipo</th>
<th style="text-align: left;">Descrição</th>
</tr>
<tr>
<td style="text-align: left;">linhaDigitavel</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Linhadigitável</td>
</tr>
<tr>
<td style="text-align: left;">codigoBanco</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Códigodo Banco</td>
</tr>
<tr>
<td style="text-align: left;">nomeBeneficiario</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Nome do Beneficiário</td>
</tr>
<tr>
<td style="text-align: left;">enderecoBeneficiario</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Endereço do Beneficiário</td>
</tr>
<tr>
<td style="text-align: left;">cpfCnpjBeneficiario</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">CPF e/ou CNPJ do Beneficiário</td>
</tr>
<tr>
<td style="text-align: left;">cooperativaBeneficiario</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Código da Cooperativa do Beneficiário</td>
</tr>
<tr>
<td style="text-align: left;">postoBeneficiario</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Código da UA do Beneficiário</td>
</tr>
<tr>
<td style="text-align: left;">codigoBeneficiario</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Códigodo Beneficiário</td>
</tr>
<tr>
<td style="text-align: left;">dataDocumento</td>
<td style="text-align: left;">Data</td>
<td style="text-align: left;">Data do Documento</td>
</tr>
<tr>
<td style="text-align: left;">seuNumero</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Seu Número</td>
</tr>
<tr>
<td style="text-align: left;">especieDocumento</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Espécie de Documento</td>
</tr>
<tr>
<td style="text-align: left;">aceite</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Aceite</td>
</tr>
<tr>
<td style="text-align: left;">dataProcessamento</td>
<td style="text-align: left;">Date</td>
<td style="text-align: left;">Data do Processamento (do dia)</td>
</tr>
<tr>
<td style="text-align: left;">nossoNumero</td>
<td style="text-align: left;">Decimal</td>
<td style="text-align: left;">Nosso Numero</td>
</tr>
<tr>
<td style="text-align: left;">especie</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Espécie: Real (Fixo)</td>
</tr>
<tr>
<td style="text-align: left;">valorDocumento</td>
<td style="text-align: left;">Decimal</td>
<td style="text-align: left;">Valordo Documento</td>
</tr>
<tr>
<td style="text-align: left;">dataVencimento</td>
<td style="text-align: left;">Date</td>
<td style="text-align: left;">Data de Vencimento</td>
</tr>
<tr>
<td style="text-align: left;">nomePagador</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Nome do Pagador</td>
</tr>
<tr>
<td style="text-align: left;">cpfCnpjPagador</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">CPF e/ou CNPJ Pagador</td>
</tr>
<tr>
<td style="text-align: left;">enderecoPagador</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Endereço do Pagador</td>
</tr>
<tr>
<td style="text-align: left;">dataLimiteDesconto</td>
<td style="text-align: left;">Date</td>
<td style="text-align: left;">Data Limite para Desconto</td>
</tr>
<tr>
<td style="text-align: left;">valorDesconto</td>
<td style="text-align: left;">Decimal</td>
<td style="text-align: left;">Valor do Desconto/Abatimento</td>
</tr>
<tr>
<td style="text-align: left;">jurosMulta</td>
<td style="text-align: left;">Decimal</td>
<td style="text-align: left;">Juros/multa</td>
</tr>
</table>
</div>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/eboleto/emitir</td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: left;border: 1px solid black;"><pre>{
"Boleto": {
"Agencia": "Número da sua agência0726", "Posto": "Número do seu posto28", "CedenteCodigoCedente": "Número do Cedente89733", "NossoNumeronossoNumero": "", "CodigoPagadorcodigoPagador": "", "TipoPessoatipoPessoa": 1"0", "CpfCnpjcpfCnpj": "02664340026", "NomeNomePagador": "teste", "EnderecoEnderecoPagador": "dolores alcaras", "Cidadecidade": "portoalegre", "UFuf": "rs", "CEPcep": "91760110", "Telefonetelefone": "5188888888", "Emailemail": "[email protected]", "EspecieDocumentoespecieDocumento": "B", "CodigoSacadorAvalistacodigoSacadorAvalista": "000", "SeuNumeroseuNumero": "1234567891", "DataVencimentodataVencimento": "26/08/2016", "Valorvalor": 10, "TipoDescontotipoDesconto": "B", "valorDesconto1": null, "dataDesconto1": null, "valorDesconto2": null, "dataDesconto2": null, "valorDesconto3": null, "dataDesconto3": null, "tipoJuros": "A", "juros": null, "multas": 1null, "TipoJurosdescontoAntecipado": 1null, "Informativoinformativo": "teste1", "Mensagemmensagem": "teste", "CodigoMensagemcodigoMensagem": ""
},
"CodigoBanco": 748
"Message": null,
"Success": true,
}</pre>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/eboleto/emitir</td>
</tr>
<tr style="border: 1px solid black;">
"CpfCnpj": "02664340026",
"Nome": "teste",
"EnderecoEnderecoPagador": "dolores alcaras",
"Cidade": "portoalegre",
"UF": "rs",
"Message": "Campo obrigatorio em branco.",
"Success": false,
}</pre>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/eboleto/consultar?Agencia=NÚMERO DA AGÊNCIA&Cedente=CÓDIGO DO CEDENTE&Posto=NÚMERO DO POSTO&NossoNumero=NÚMERO DO BOLETO NO BANCO&CodigoBanco=CÓDIGO DO BANCO</td>
</tr>
<tr style="border: 1px solid black;">
Caso contrário, são obrigatórios serem informados os parâmetros ''Agencia'', ''Cedente'', ''Posto'' e ''CodigoBanco''.
*AgênciaAgencia: Informar o número de sua agência para pesquisa de boletos;
*Cedente: Informar o código do Cedente vinculado ao boleto;
*Posto: Informar o código do posto de seu banco;
"Message": null,
"Success": true,
}</pre></td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/eboleto/consultar?Agencia=NÚMERO DA AGÊNCIA&Cedente=CÓDIGO DO CEDENTE&Posto=NÚMERO DO POSTO&NossoNumero=NÚMERO DO BOLETO NO BANCO&CodigoBanco=CÓDIGO DO BANCO</td>
</tr>
<tr style="border: 1px solid black;">
Caso contrário, são obrigatórios serem informados os parâmetros ''Agencia'', ''Cedente'', ''Posto'' e ''CodigoBanco''.
*AgênciaAgencia: Informar o número de sua agência para pesquisa de boletos;
*Cedente: Informar o código do Cedente vinculado ao boleto;
*Posto: Informar o código do posto de seu banco;
"Message": "Campo obrigatorio em branco. - Parâmetro: agencia",
"Success": false,
}</pre></td>
</tr>
</div>
==Realizando a consulta de um boleto==
===Entendendo as propriedades de retorno===
Antes de iniciarmos a consulta, vamos entender as propriedades que serão retornadas.
<div class="center">
<table border=1 cellpadding=0 cellspacing=0 style='border-collapse: collapse;table-layout:fixed;width:800px'>
<tr>
<th>Nome</th>
<th>Tipo</th>
<th>Descição</th>
</tr>
<tr>
<td style="text-align: left;">seuNumero</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Seu Número</td>
</tr>
<tr>
<td style="text-align: left;">nossoNumero</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Nosso número</td>
</tr>
<tr>
<td style="text-align: left;">nomePagador</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Nome do Pagador</td>
</tr>
<tr>
<td style="text-align: left;">valor</td>
<td style="text-align: left;">Decimal</td>
<td style="text-align: left;">Valor do documento</td>
</tr>
<tr>
<td style="text-align: left;">valorLiquidado</td>
<td style="text-align: left;">Decimal</td>
<td style="text-align: left;">Valor liquidado</td>
</tr>
<tr>
<td style="text-align: left;">dataEmissao</td>
<td style="text-align: left;">Date</td>
<td style="text-align: left;">Data da emissão</td>
</tr>
<tr>
<td style="text-align: left;">dataVencimento</td>
<td style="text-align: left;">Date</td>
<td style="text-align: left;">Data de vencimento</td>
</tr>
<tr>
<td style="text-align: left;">dataLiquidacao</td>
<td style="text-align: left;">Date</td>
<td style="text-align: left;">Data da liquidação</td>
</tr>
<tr>
<td style="text-align: left;">situacao</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">
0. EM CARTEIRA<br>
1. LIQUIDADO<br>
2. BAIXADO POR SOLICITACAO<br>
3. BAIXADO POR PROTESTO<br>
4. EM CARTORIO<br>
5. AGUARDANDO ENTRADA EM CARTORIO<br>
6. AGUARDANDO SUSTACAO DE CARTORIO<br>
7. REJEITADO<br>
8. OUTROS
</td>
</tr>
</table>
</div>
===Caso de Sucesso===
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/eboleto/consultar?Agencia=NÚMERO DA AGÊNCIA&Cedente=CÓDIGO DO CEDENTE&Posto=NÚMERO DO POSTO&'''NossoNumero=NÚMERO DO BOLETO NO BANCO'''&CodigoBanco=CÓDIGO DO BANCO</td>
</tr>
<tr style="border: 1px solid black;">
Caso contrário, são obrigatórios serem informados os parâmetros ''Agencia'', ''Cedente'', ''Posto'' e ''CodigoBanco''.
*AgênciaAgencia: Informar o número de sua agência para pesquisa de boletos;
*Cedente: Informar o código do Cedente vinculado ao boleto;
*Posto: Informar o código do posto de seu banco;
"Message": "",
"Success": true,
}</pre></td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/eboleto/consultar?Agencia=NÚMERO DA AGÊNCIA&Cedente=CÓDIGO DO CEDENTE&Posto=NÚMERO DO POSTO&'''NossoNumero=NÚMERO INCORRETO DO BOLETO NO BANCO'''&CodigoBanco=CÓDIGO DO BANCO</td>
</tr>
<tr style="border: 1px solid black;">
Caso contrário, são obrigatórios serem informados os parâmetros ''Agencia'', ''Cedente'', ''Posto'' e ''CodigoBanco''.
*AgênciaAgencia: Informar o número de sua agência para pesquisa de boletos;
*Cedente: Informar o código do Cedente vinculado ao boleto;
*Posto: Informar o código do posto de seu banco;
"Message": "Nao foram encontrados resultados para os filtros de consulta informados. - Parâmetro: ",
"Success": false,
}</pre></td>
</tr>
</table>
</div>
==Realizando uma ação no boleto==
Este tópico demonstra como realizar uma ação em um boleto emitido pelo ERP.Net
<div class="center">
<table style="border: 1px solid black;border-collapse: collapse;width: 800px;">
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/eboleto/executarcomando</td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Método</td>
<td style="text-align: left;border: 1px solid black;">POST</td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Body<br/>(JSON)</td>
<td style="text-align: left;border: 1px solid black;">Localize abaixo os possíveis comandos que podem ser executados.
O código do banco utilizado é o 748, pois apenas o Sicredi é aceito até o momento.</td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Retorno<br/>(JSON)</td>
<td style="text-align: left;border: 1px solid black;"><pre>{
"Message": "",
"StatusCode": 200,
"Success": true
}</pre>
<br/>
Caso não consiga executar algum comando, a propriedade "Message" retornará o erro em questão e a propriedade "Success" será falso (false).
</td>
</tr>
</table>
</div>
===Possíveis comandos para execução===
Segue o corpo dos JSON's dos possíveis comandos que pode ser executados:
* Alteração de Vencimento
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000352",
"acaoComando": "AlteracaoDeVencimento",
"novoValor": "30/06/2018"
}</pre>
* Alteração do seu número
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "AlteracaoSeuNumero",
"novoValor": "1234"
}</pre>
* Pedido de Baixa
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000352",
"acaoComando": "PedidoDeBaixa"
}</pre>
* Concessão de Abatimento
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "ConcessaoDeAbatimento",
"novoValor": 3
}</pre>
* Cancelamento de abatimento concedido
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "CancelamentoDeAbatimentoConcedido"
}</pre>
* Alteração da data limite para desconto
Altera somente a data, o valor não. Caso o boleto emitido
esteja somente com uma data de desconto cadastrada, irá alterar somente a data cadastrada. Se o
boleto foi emitido sem nenhuma data de desconto, nada será alterado.
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "AlteracaoOutrosDados",
"acaoComandoComplementar": "DataLimiteConcessaoDesconto",
"novoValor": "10/05/2018"
}</pre>
* Alteração de desconto
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "AlteracaoOutrosDados",
"acaoComandoComplementar": "Desconto",
"novoValor": 1
}</pre>
* Alteração de juros por dia
Muda somente o valor do juros por dia.
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "AlteracaoOutrosDados",
"acaoComandoComplementar": "JurosDia",
"novoValor": 2.5
}</pre>
* Desconto por dia de antecipação
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000379",
"acaoComando": "AlteracaoOutrosDados",
"acaoComandoComplementar": "DescontoDiaAntecipacao",
"novoValor": 1.5
}</pre>
* Pedido de Protesto
Somente em título vencido.
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "PedidoDeProtesto"
}</pre>
* Sustar o processo por baixa
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "SustarProtestoEBaixarTitulo"
}</pre>
* Sustar protesto e manter a carteira
<pre>{
"codigoBanco": "748",
"agencia": "0100",
"posto": "02",
"cedente": "00248",
"nossoNumero": "181000360",
"acaoComando": "SustarProtestoEManterCarteira"
}</pre>
