GET api/v3/Conta?CodigoDeBarras={CodigoDeBarras}&Status={Status}&DataSolicitacaoInicio={DataSolicitacaoInicio}&DataSolicitacaoFim={DataSolicitacaoFim}&DataVencimentoInicio={DataVencimentoInicio}&DataVencimentoFim={DataVencimentoFim}&DataPagamentoInicio={DataPagamentoInicio}&DataPagamentoFim={DataPagamentoFim}&ApenasAgendados={ApenasAgendados}&IncluirCancelados={IncluirCancelados}&DataAgendamentoInicio={DataAgendamentoInicio}&DataAgendamentoFim={DataAgendamentoFim}&Descricao={Descricao}&DetranSP={DetranSP}

Lista as contas com base nos filtros.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CodigoDeBarras

string

None.

Status

StatusDocumentoFinanceiro

None.

DataSolicitacaoInicio

date

None.

DataSolicitacaoFim

date

None.

DataVencimentoInicio

date

None.

DataVencimentoFim

date

None.

DataPagamentoInicio

date

None.

DataPagamentoFim

date

None.

ApenasAgendados

boolean

None.

IncluirCancelados

boolean

None.

DataAgendamentoInicio

date

None.

DataAgendamentoFim

date

None.

Descricao

string

None.

DetranSP

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Lista de contas.

Collection of ContaNaConsultaDto
NameDescriptionTypeAdditional information
Id

integer

None.

CodigoDeBarras

string

None.

LinhaDigitavel

string

None.

Status

StatusDocumentoFinanceiro

None.

Solicitacao

date

None.

Vencimento

date

None.

Agendamento

date

None.

Pagamento

date

None.

NomeTitulo

string

None.

NomeComprovante

string

None.

Descricao

string

None.

Observacao

string

None.

Valor

decimal number

None.

Desconto

decimal number

None.

Acrescimos

decimal number

None.

ValorPago

decimal number

None.

QuantidadeVisualizacoes

integer

None.

DebitoNovo

boolean

None.

Estorno

EstornoDeDoctoFinanceiroDto

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "CodigoDeBarras": "sample string 2",
    "LinhaDigitavel": "sample string 3",
    "Status": "Pendente",
    "Solicitacao": "23/07/2019",
    "Vencimento": "23/07/2019",
    "Agendamento": "23/07/2019",
    "Pagamento": "23/07/2019",
    "NomeTitulo": "sample string 5",
    "NomeComprovante": "sample string 6",
    "Descricao": "sample string 7",
    "Observacao": null,
    "Valor": 8.0,
    "Desconto": 9.0,
    "Acrescimos": 10.0,
    "ValorPago": 11.0,
    "QuantidadeVisualizacoes": 12,
    "DebitoNovo": true,
    "Estorno": {
      "Id": 1,
      "Valor": 2.0,
      "Data": "23/07/2019",
      "Motivo": "sample string 4"
    }
  },
  {
    "Id": 1,
    "CodigoDeBarras": "sample string 2",
    "LinhaDigitavel": "sample string 3",
    "Status": "Pendente",
    "Solicitacao": "23/07/2019",
    "Vencimento": "23/07/2019",
    "Agendamento": "23/07/2019",
    "Pagamento": "23/07/2019",
    "NomeTitulo": "sample string 5",
    "NomeComprovante": "sample string 6",
    "Descricao": "sample string 7",
    "Observacao": null,
    "Valor": 8.0,
    "Desconto": 9.0,
    "Acrescimos": 10.0,
    "ValorPago": 11.0,
    "QuantidadeVisualizacoes": 12,
    "DebitoNovo": true,
    "Estorno": {
      "Id": 1,
      "Valor": 2.0,
      "Data": "23/07/2019",
      "Motivo": "sample string 4"
    }
  }
]