Mudanças

Ir para: navegação, pesquisa

Manuais:ERP.Net/API/EBoleto

4 859 bytes adicionados, 14h23min de 7 de julho de 2022
Adicionado __NOTITLE__
__NOTITLE__
<big>'''E-Boleto - Sistema emissor de boletos eletrônicos.'''</big>
<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>
</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>
<table border=1 cellpadding=0 cellspacing=0 style='border-collapse: collapse;width:800px'>
<tr>
<th style="text-align: left;">NomeNomePagador</th>
<th style="text-align: left;">Tipo</th>
<th style="text-align: left;">Descrição</th>
<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
<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",
<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;
<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;
<td style="text-align: left;">String</td>
<td style="text-align: left;">
10. EM CARTEIRA<br> 21. LIQUIDADO<br> 32. BAIXADO POR SOLICITACAO<br> 43. BAIXADO POR PROTESTO<br> 54. EM CARTORIO<br> 65. AGUARDANDO ENTRADA EM CARTORIO<br> 76. AGUARDANDO SUSTACAO DE CARTORIO<br> 87. REJEITADO<br> 98. OUTROS
</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;
<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;
</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>
1 153
edições

Menu de navegação