GET api/v5/Boleto?DataInicio={DataInicio}&DataFim={DataFim}&Status={Status}&Documento={Documento}&SeuNumero={SeuNumero}&IncluirCancelados={IncluirCancelados}&ApenasAgendados={ApenasAgendados}&NaoVisualizados={NaoVisualizados}

Busca uma lista de boletos com base em filtros.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
DataInicio

date

None.

DataFim

date

None.

Status

StatusBoletoRelatorio

None.

Documento

string

None.

SeuNumero

string

None.

IncluirCancelados

boolean

None.

ApenasAgendados

boolean

None.

NaoVisualizados

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Lista de boletos.

Collection of ItemRelatorioBoletoDto
NameDescriptionTypeAdditional information
SeuNumero

string

None.

Vencimento

date

None.

EstaVencido

boolean

None.

Documento

string

None.

Sacado

string

None.

DataPagamento

date

None.

DataEnvioEmail

date

None.

Valor

decimal number

None.

ValorPago

decimal number

None.

ValorLiquido

decimal number

None.

ValorEmBaixaOperacional

decimal number

None.

TarifasCobradas

Collection of TarifaCobradaDto

None.

TemPagamento

boolean

None.

Url

string

None.

Linha1

string

None.

Linha2

string

None.

Cancelado

boolean

None.

QuantidadeVisualizacoes

integer

None.

QuantidadeRejeicoes

integer

None.

QuantidadePagamentos

integer

None.

Email

string

None.

NossoNumero

string

None.

Parcela

string

None.

Emissao

date

None.

CodigoBarras

string

None.

LinhaDigitavel

string

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SeuNumero": "sample string 1",
    "Vencimento": "22/03/2019",
    "EstaVencido": true,
    "Documento": "sample string 4",
    "Sacado": "sample string 5",
    "DataPagamento": "22/03/2019",
    "DataEnvioEmail": "22/03/2019",
    "Valor": 6.0,
    "ValorPago": 7.0,
    "ValorLiquido": 8.0,
    "ValorEmBaixaOperacional": 9.0,
    "TarifasCobradas": [
      {
        "Tipo": "NaoDefinido",
        "Valor": 1.0
      },
      {
        "Tipo": "NaoDefinido",
        "Valor": 1.0
      }
    ],
    "TemPagamento": true,
    "Url": "sample string 10",
    "Linha1": "sample string 11",
    "Linha2": "sample string 12",
    "Cancelado": true,
    "QuantidadeVisualizacoes": 14,
    "QuantidadeRejeicoes": 15,
    "QuantidadePagamentos": 16,
    "Email": "sample string 17",
    "NossoNumero": "sample string 18",
    "Parcela": "sample string 19",
    "Emissao": "22/03/2019",
    "CodigoBarras": "sample string 20",
    "LinhaDigitavel": "sample string 21",
    "Id": 22
  },
  {
    "SeuNumero": "sample string 1",
    "Vencimento": "22/03/2019",
    "EstaVencido": true,
    "Documento": "sample string 4",
    "Sacado": "sample string 5",
    "DataPagamento": "22/03/2019",
    "DataEnvioEmail": "22/03/2019",
    "Valor": 6.0,
    "ValorPago": 7.0,
    "ValorLiquido": 8.0,
    "ValorEmBaixaOperacional": 9.0,
    "TarifasCobradas": [
      {
        "Tipo": "NaoDefinido",
        "Valor": 1.0
      },
      {
        "Tipo": "NaoDefinido",
        "Valor": 1.0
      }
    ],
    "TemPagamento": true,
    "Url": "sample string 10",
    "Linha1": "sample string 11",
    "Linha2": "sample string 12",
    "Cancelado": true,
    "QuantidadeVisualizacoes": 14,
    "QuantidadeRejeicoes": 15,
    "QuantidadePagamentos": 16,
    "Email": "sample string 17",
    "NossoNumero": "sample string 18",
    "Parcela": "sample string 19",
    "Emissao": "22/03/2019",
    "CodigoBarras": "sample string 20",
    "LinhaDigitavel": "sample string 21",
    "Id": 22
  }
]