Comprovantes

Disponibilizamos operações de consulta e exportação de comprovantes em PDF de pagamentos.

Consulta Comprovantes

A funcionalidade permite a consulta por um comprovante de pagamento.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
dataInicial	Data inicial da pesquisa	date-time	Sim
dataFinal	Data final da pesquisa	date-time	Sim
tipoFiltro	Código do tipo de filtro, conforme tabela [Tipo de filtro]	integer	Sim

Resposta:

Campo	Descrição	Formato	Nullable
comprovanteId	Identificador único do comprovante	string	Não
empresa	Dados da empresa	Object	Sim
EfetuadoEm	Data em que o pagamento foi efetuado	date-time	Sim
EfetuarEm	Data em que o pagamento será efetuado, e nesse caso o pagamento está agendado	date-time	Sim
tipo	Código do tipo de comprovante, conforme tabela [Tipo de comprovante]	integer	Não
protocolo	Número do protocolo do pagamento	string	Sim
dadosTransferencia	Apresenta o valor, favorecido e dados bancários do favorecido	object	Sim
dadosPagamento	Apresenta o beneficiário, sacador avalista, pagador, cedente, banco emissor do pagamento, linha digitável, vencimento e valores (pago, desconto, mora, deduções, acrescimos, encargos, etc) do boleto	object	Sim
dadosTributo	Apresenta dados do pagador, pagador final, vencimento, valores (pago, juros, etc) do tributo	object	Sim
dadosPagamentoPix	Apresenta os dados de recebedor (nome, CPF/CNPJ e dados bancários), valor, valor de tarifa, chave e endToEndId	objetc	Sim

A funcionalidade permite gerar o comprovante de pagamento no formato PFD.

Solicitamos os campos:

Campo	Descrição	Formato
comprovanteId	Identificador do comprovante	string
TipoComprovante	Código do tipo de comprovante, conforme tabela [Tipo de comprovante]	integer

E como resultado é efetuado o download do PDF.

Na tabela abaixo, listamos os tipos de filtros:

Na tabela a seguir, são listados os tipos de comprovantes:

Enumeração	Descrição
1	Transferencia
2	Pagamento
3	PagamentoTributo
4	AgendamentoTransferencia
5	AgendamentoPagamento
6	AgendamentoPagamentoTributo
7	PagamentoPix