POST api/Boletos/InformarBoleto

Informe somente um boleto vencido, atenção essa funcionalidade não ira inativar boletos anteriores

Request Information

URI Parameters

None.

Body Parameters

JsonBoleto
NameDescriptionTypeAdditional information
NroNotaFiscal

integer

None.

CodigoCliente

integer

None.

NomeCliente

string

None.

Parcela

string

None.

StatusBoleto

string

None.

Vencimento

date

None.

Valor

decimal number

None.

LinhaDigitavel

string

None.

Arquivo

JsonArquivo

None.

Request Formats

application/json, text/json

Sample:
{
  "NroNotaFiscal": 1,
  "CodigoCliente": 2,
  "NomeCliente": "sample string 3",
  "Parcela": "sample string 4",
  "StatusBoleto": "sample string 5",
  "Vencimento": "2025-12-17T21:11:10.2815271-03:00",
  "Valor": 7.0,
  "LinhaDigitavel": "sample string 8",
  "Arquivo": {
    "NomeArquivo": "sample string 1",
    "TipoArquivo": "sample string 2",
    "Conteudo": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<JsonBoleto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transicold.Garantia.Dominio.Entidades.Api">
  <Arquivo>
    <Conteudo>sample string 3</Conteudo>
    <NomeArquivo>sample string 1</NomeArquivo>
    <TipoArquivo>sample string 2</TipoArquivo>
  </Arquivo>
  <CodigoCliente>2</CodigoCliente>
  <LinhaDigitavel>sample string 8</LinhaDigitavel>
  <NomeCliente>sample string 3</NomeCliente>
  <NroNotaFiscal>1</NroNotaFiscal>
  <Parcela>sample string 4</Parcela>
  <StatusBoleto>sample string 5</StatusBoleto>
  <Valor>7</Valor>
  <Vencimento>2025-12-17T21:11:10.2815271-03:00</Vencimento>
</JsonBoleto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MensagemRetornoController
NameDescriptionTypeAdditional information
MensagemRetorno

Mensagem de retorno

string

None.

Retorno

objeto de retorno caso exista se não existir será nulo

Object

None.

IsOK

função executou corretamente ou deu erro = false verificar a mensagem de retorno

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "MensagemRetorno": "sample string 1",
  "Retorno": {},
  "IsOK": true
}

application/xml, text/xml

Sample:
<MensagemRetornoController xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transicold.Garantia.Web.Api.Controllers">
  <IsOK>true</IsOK>
  <MensagemRetorno>sample string 1</MensagemRetorno>
  <Retorno />
</MensagemRetornoController>