Mudanças entre as edições de "Manuais:ERP.Net/API/EBoleto"

De unimake
Ir para: navegação, pesquisa
(Criou página com '<big>'''E-Boleto - Sistema emissor de boletos eletrônicos.'''</big> ==Acessando a API== Para realizar o acesso à API é necessário estar logado no serviço. <br/>Verifiq...')
 
Linha 216: Linha 216:
  
 
A propriedade ''Data'' possui o resultado original do banco em questão. Pode variar de banco para banco.
 
A propriedade ''Data'' possui o resultado original do banco em questão. Pode variar de banco para banco.
 +
 +
==Realizando a consulta de um boleto emitido==
 +
===Caso de Sucesso===
 +
<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/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;">
 +
<td style="text-align: center;padding: 7px;border: 1px solid black;">Método</td>
 +
<td style="text-align: left;border: 1px solid black;">GET</td>
 +
</tr>
 +
<tr style="border: 1px solid black;">
 +
<td style="text-align: center;padding: 7px;border: 1px solid black;">QUERYSTRING</td>
 +
<td style="text-align: left;border: 1px solid black;">
 +
Todos os parâmetros são opcionais, caso seja informado no ERP.Net.
 +
Caso contrário, são obrigatórios serem informados os parâmetros ''Agencia'', ''Cedente'', ''Posto'' e ''CodigoBanco''.
 +
 +
*Agência: 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;
 +
*NossoNumero: Se informado, realiza a pesquisa apenas do boleto em questão;
 +
*CodigoBanco: Se configurado no ERP.Net, não é necessário passar este parâmetro.</td>
 +
</tr>
 +
<tr style="border: 1px solid black;">
 +
<td style="text-align: center;padding: 7px;border: 1px solid black;">Retorno<br/>(DATA)</td>
 +
<td style="text-align: left;border: 1px solid black;"><pre>{
 +
  "Data": [
 +
    {
 +
      "DataEmissao": "2018-03-23T00:00:00",
 +
      "DataLiquidacao": null,
 +
      "DataVencimento": "2016-08-26T00:00:00",
 +
      "NomePagador": "TESTE",
 +
      "NossoNumero": "181000013",
 +
      "Parametro": null,
 +
      "SeuNumero": "1234567891",
 +
      "Situacao": "BAIXADO POR SOLICITACAO",
 +
      "Valor": 10.5,
 +
      "ValorLiquidado": 0,
 +
      "Codigo": null,
 +
      "Mensagem": null,
 +
      "Success": true
 +
    },
 +
    {
 +
      "DataEmissao": "2018-03-23T00:00:00",
 +
      "DataLiquidacao": null,
 +
      "DataVencimento": "2016-08-26T00:00:00",
 +
      "NomePagador": "TESTE",
 +
      "NossoNumero": "181000021",
 +
      "Parametro": null,
 +
      "SeuNumero": "1234567891",
 +
      "Situacao": "BAIXADO POR SOLICITACAO",
 +
      "Valor": 10.5,
 +
      "ValorLiquidado": 0,
 +
      "Codigo": null,
 +
      "Mensagem": null,
 +
      "Success": true
 +
    },
 +
    {
 +
      "DataEmissao": "2018-05-15T00:00:00",
 +
      "DataLiquidacao": null,
 +
      "DataVencimento": "0001-01-01T00:00:00",
 +
      "NomePagador": "TESTE",
 +
      "NossoNumero": "181000242",
 +
      "Parametro": null,
 +
      "SeuNumero": "1234567891",
 +
      "Situacao": "EM CARTEIRA",
 +
      "Valor": 10,
 +
      "ValorLiquidado": 0,
 +
      "Codigo": null,
 +
      "Mensagem": null,
 +
      "Success": true
 +
    }
 +
  ],
 +
  "Message": null,
 +
  "Success": true,
 +
  "Version": {
 +
    "Major": 1,
 +
    "Minor": 1,
 +
    "Build": -1,
 +
    "Revision": -1,
 +
    "MajorRevision": -1,
 +
    "MinorRevision": -1
 +
  },
 +
  "Content": null,
 +
  "StatusCode": 200,
 +
  "ReasonPhrase": "OK",
 +
  "Headers": [],
 +
  "RequestMessage": null,
 +
  "IsSuccessStatusCode": true
 +
}</pre></td>
 +
</tr>
 +
</table>
 +
</div>
 +
 +
===Caso de Falha===
 +
 +
Para simular a falha, iremos omitir o parâmetro ''Agencia''.
 +
 +
<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/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;">
 +
<td style="text-align: center;padding: 7px;border: 1px solid black;">Método</td>
 +
<td style="text-align: left;border: 1px solid black;">GET</td>
 +
</tr>
 +
<tr style="border: 1px solid black;">
 +
<td style="text-align: center;padding: 7px;border: 1px solid black;">QUERYSTRING</td>
 +
<td style="text-align: left;border: 1px solid black;">
 +
Todos os parâmetros são opcionais, caso seja informado no ERP.Net.
 +
Caso contrário, são obrigatórios serem informados os parâmetros ''Agencia'', ''Cedente'', ''Posto'' e ''CodigoBanco''.
 +
 +
*Agência: 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;
 +
*NossoNumero: Se informado, realiza a pesquisa apenas do boleto em questão;
 +
*CodigoBanco: Se configurado no ERP.Net, não é necessário passar este parâmetro.</td>
 +
</tr>
 +
<tr style="border: 1px solid black;">
 +
<td style="text-align: center;padding: 7px;border: 1px solid black;">Retorno<br/>(DATA)</td>
 +
<td style="text-align: left;border: 1px solid black;"><pre>{
 +
    "Data": [
 +
        {
 +
            "DataEmissao": null,
 +
            "DataLiquidacao": null,
 +
            "DataVencimento": null,
 +
            "NomePagador": null,
 +
            "NossoNumero": null,
 +
            "Parametro": "agencia",
 +
            "SeuNumero": null,
 +
            "Situacao": null,
 +
            "Valor": null,
 +
            "ValorLiquidado": null,
 +
            "Codigo": "E0010",
 +
            "Mensagem": "Campo obrigatorio em branco. - Parâmetro: agencia",
 +
            "Success": false
 +
        }
 +
    ],
 +
    "Message": "Campo obrigatorio em branco. - Parâmetro: agencia",
 +
    "Success": false,
 +
    "Version": {
 +
        "Major": 1,
 +
        "Minor": 1,
 +
        "Build": -1,
 +
        "Revision": -1,
 +
        "MajorRevision": -1,
 +
        "MinorRevision": -1
 +
    },
 +
    "Content": null,
 +
    "StatusCode": 500,
 +
    "ReasonPhrase": "OK",
 +
    "Headers": [],
 +
    "RequestMessage": null,
 +
    "IsSuccessStatusCode": false
 +
}</pre></td>
 +
</tr>
 +
</table>
 +
</div>

Edição das 01h05min de 16 de maio de 2018

E-Boleto - Sistema emissor de boletos eletrônicos.

Acessando a API

Para realizar o acesso à API é necessário estar logado no serviço.
Verifique como realizar a autenticação na página Autenticando na API.

Realizando a emissão de um boleto

Caso de Sucesso

Endpoint https://erpnet.online/api/eboleto/emitir
Método POST
Body
(JSON)		 
{
  "Boleto": {
    "Agencia": "Número da sua agência",
    "Posto": "Número do seu posto",
    "Cedente": "Número do Cedente",
    "NossoNumero": "",
    "CodigoPagador": "",
    "TipoPessoa": 1,
    "CpfCnpj": "02664340026",
    "Nome": "teste",
    "Endereco": "dolores alcaras",
    "Cidade": "portoalegre",
    "UF": "rs",
    "CEP": "91760110",
    "Telefone": "5188888888",
    "Email": "[email protected]",
    "EspecieDocumento": "B",
    "CodigoSacadorAvalista": "000",
    "SeuNumero": "1234567891",
    "DataVencimento": "26/08/2016",
    "Valor": 10,
    "TipoDesconto": 1,
    "TipoJuros": 1,
    "Informativo": "teste1",
    "Mensagem": "teste",
    "CodigoMensagem": ""
  },
  "CodigoBanco": 748
}
O código do banco utilizado é o 748, pois apenas o Sicredi é aceito até o momento.
Retorno
(DATA)		 
{
    "Data": {
        "Aceite": "N",
        "Arquivo": null,
        "CodigoBanco": 748,
        "CodigoBeneficiario": "94914",
        "CpfCnpjBeneficiario": "06117473000150",
        "CpfCnpjPagador": "02664340026",
        "DataDocumento": "2018-05-15T00:00:00",
        "DataEmissao": null,
        "DataLimiteDesconto": null,
        "DataLiquidacao": null,
        "DataProcessamento": "2018-05-15T00:00:00",
        "DataVencimento": "0001-01-01T00:00:00",
        "EnderecoBeneficiario": "R. ANTONIO FELIPE, 1500",
        "EnderecoPagador": "DOLORES ALCARAS",
        "Especie": "REAL",
        "EspecieDocumento": "B",
        "JurosMulta": 0,
        "LinhaDigitavel": "74891118100002420718513949141074886950000001000",
        "NomeBeneficiario": "UNIMAKE SOLUCOES CORPORATIVAS",
        "NomePagador": "TESTE",
        "NossoNumero": "181000242",
        "OoperativaBeneficiario": null,
        "PostoBeneficiario": "13",
        "SeuNumero": "1234567891",
        "Situacao": null,
        "Valor": 0,
        "ValorDesconto": 0,
        "ValorDocumento": 10,
        "ValorLiquidado": null,
        "Codigo": null,
        "Mensagem": null,
        "Success": true
    },
    "Message": null,
    "Success": true,
    "Version": {
        "Major": 1,
        "Minor": 1,
        "Build": -1,
        "Revision": -1,
        "MajorRevision": -1,
        "MinorRevision": -1
    },
    "Content": null,
    "StatusCode": 200,
    "ReasonPhrase": "OK",
    "Headers": [],
    "RequestMessage": null,
    "IsSuccessStatusCode": true
}

É retornado o boleto emitido em caso de sucesso. Propriedade Success = true.

Caso seja retornado Success = false verifique a mensagem de erro em Message

Caso de falha

Endpoint https://erpnet.online/api/eboleto/emitir
Método POST
Body
(JSON)		 
{
  "Boleto": {
    "NossoNumero": "",
    "CodigoPagador": "",
    "TipoPessoa": 1,
    "CpfCnpj": "02664340026",
    "Nome": "teste",
    "Endereco": "dolores alcaras",
    "Cidade": "portoalegre",
    "UF": "rs",
    "CEP": "91760110",
    "Telefone": "5188888888",
    "Email": "[email protected]",
    "EspecieDocumento": "B",
    "CodigoSacadorAvalista": "000",
    "SeuNumero": "1234567891",
    "DataVencimento": "26/08/2016",
    "Valor": 10,
    "TipoDesconto": 1,
    "TipoJuros": 1,
    "Informativo": "teste1",
    "Mensagem": "teste",
    "CodigoMensagem": ""
  },
  "CodigoBanco": 748
}
O código do banco utilizado é o 748, pois apenas o Sicredi é aceito até o momento.
Retorno
(DATA)		 
{
    "Data": {
        "Aceite": null,
        "Arquivo": null,
        "CodigoBanco": 0,
        "CodigoBeneficiario": null,
        "CpfCnpjBeneficiario": null,
        "CpfCnpjPagador": null,
        "DataDocumento": null,
        "DataEmissao": null,
        "DataLimiteDesconto": null,
        "DataLiquidacao": null,
        "DataProcessamento": null,
        "DataVencimento": null,
        "EnderecoBeneficiario": null,
        "EnderecoPagador": null,
        "Especie": null,
        "EspecieDocumento": null,
        "JurosMulta": null,
        "LinhaDigitavel": null,
        "NomeBeneficiario": null,
        "NomePagador": null,
        "NossoNumero": null,
        "OoperativaBeneficiario": null,
        "PostoBeneficiario": null,
        "SeuNumero": null,
        "Situacao": null,
        "Valor": 0,
        "ValorDesconto": null,
        "ValorDocumento": null,
        "ValorLiquidado": null,
        "Codigo": "E0010",
        "Mensagem": "Campo obrigatorio em branco.",
        "Success": false
    },
    "Message": "Campo obrigatorio em branco.",
    "Success": false,
    "Version": {
        "Major": 1,
        "Minor": 1,
        "Build": -1,
        "Revision": -1,
        "MajorRevision": -1,
        "MinorRevision": -1
    },
    "Content": null,
    "StatusCode": 500,
    "ReasonPhrase": "OK",
    "Headers": [],
    "RequestMessage": null,
    "IsSuccessStatusCode": false
}

Perceba que não colocamos os campos Agencia, Posto e Cedente na requisição. O retorno foi Success = false com a propriedade Message preenchida com o erro.

A propriedade Data possui o resultado original do banco em questão. Pode variar de banco para banco.

Realizando a consulta de um boleto emitido

Caso de Sucesso

Endpoint https://erpnet.online/api/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
Método GET
QUERYSTRING 
Todos os parâmetros são opcionais, caso seja informado no ERP.Net.
Caso contrário, são obrigatórios serem informados os parâmetros Agencia, Cedente, Posto e CodigoBanco.
  • Agência: 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;
  • NossoNumero: Se informado, realiza a pesquisa apenas do boleto em questão;
  • CodigoBanco: Se configurado no ERP.Net, não é necessário passar este parâmetro.
Retorno
(DATA)		 
{
  "Data": [
    {
      "DataEmissao": "2018-03-23T00:00:00",
      "DataLiquidacao": null,
      "DataVencimento": "2016-08-26T00:00:00",
      "NomePagador": "TESTE",
      "NossoNumero": "181000013",
      "Parametro": null,
      "SeuNumero": "1234567891",
      "Situacao": "BAIXADO POR SOLICITACAO",
      "Valor": 10.5,
      "ValorLiquidado": 0,
      "Codigo": null,
      "Mensagem": null,
      "Success": true
    },
    {
      "DataEmissao": "2018-03-23T00:00:00",
      "DataLiquidacao": null,
      "DataVencimento": "2016-08-26T00:00:00",
      "NomePagador": "TESTE",
      "NossoNumero": "181000021",
      "Parametro": null,
      "SeuNumero": "1234567891",
      "Situacao": "BAIXADO POR SOLICITACAO",
      "Valor": 10.5,
      "ValorLiquidado": 0,
      "Codigo": null,
      "Mensagem": null,
      "Success": true
    },
    {
      "DataEmissao": "2018-05-15T00:00:00",
      "DataLiquidacao": null,
      "DataVencimento": "0001-01-01T00:00:00",
      "NomePagador": "TESTE",
      "NossoNumero": "181000242",
      "Parametro": null,
      "SeuNumero": "1234567891",
      "Situacao": "EM CARTEIRA",
      "Valor": 10,
      "ValorLiquidado": 0,
      "Codigo": null,
      "Mensagem": null,
      "Success": true
    }
  ],
  "Message": null,
  "Success": true,
  "Version": {
    "Major": 1,
    "Minor": 1,
    "Build": -1,
    "Revision": -1,
    "MajorRevision": -1,
    "MinorRevision": -1
  },
  "Content": null,
  "StatusCode": 200,
  "ReasonPhrase": "OK",
  "Headers": [],
  "RequestMessage": null,
  "IsSuccessStatusCode": true
}

Caso de Falha

Para simular a falha, iremos omitir o parâmetro Agencia.

Endpoint https://erpnet.online/api/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
Método GET
QUERYSTRING 
Todos os parâmetros são opcionais, caso seja informado no ERP.Net.
Caso contrário, são obrigatórios serem informados os parâmetros Agencia, Cedente, Posto e CodigoBanco.
  • Agência: 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;
  • NossoNumero: Se informado, realiza a pesquisa apenas do boleto em questão;
  • CodigoBanco: Se configurado no ERP.Net, não é necessário passar este parâmetro.
Retorno
(DATA)		 
{
    "Data": [
        {
            "DataEmissao": null,
            "DataLiquidacao": null,
            "DataVencimento": null,
            "NomePagador": null,
            "NossoNumero": null,
            "Parametro": "agencia",
            "SeuNumero": null,
            "Situacao": null,
            "Valor": null,
            "ValorLiquidado": null,
            "Codigo": "E0010",
            "Mensagem": "Campo obrigatorio em branco. - Parâmetro: agencia",
            "Success": false
        }
    ],
    "Message": "Campo obrigatorio em branco. - Parâmetro: agencia",
    "Success": false,
    "Version": {
        "Major": 1,
        "Minor": 1,
        "Build": -1,
        "Revision": -1,
        "MajorRevision": -1,
        "MinorRevision": -1
    },
    "Content": null,
    "StatusCode": 500,
    "ReasonPhrase": "OK",
    "Headers": [],
    "RequestMessage": null,
    "IsSuccessStatusCode": false
}
Disponível em "http://wiki.unimake.com.br/index.php?title=Manuais:ERP.Net/API/EBoleto&oldid=553"